FurserDaemon.txt

This readme file is written to help using the FurserDaemon.exe
(Windows service/process). Do not use this document with the Linux
variant of the program.

******************************************************************************
* Files
******************************************************************************
FurserDaemon.txt       - This readme file
RunProcess.cmd         - Runs the FurserDaemon as a process
ServiceInstall.cmd     - Installs as a service
ServicePause.cmd       - Pauses the service
ServiceRemove.cmd      - Removes installed service
ServiceStart.cmd       - Starts the service
ServiceStop.cmd        - Stops the service

bin\FurserDaemon.exe   - The FurserDaemon application

etc\FurserDaemon.ini   - Default initialization file

******************************************************************************
* Installation as a service (easy):
******************************************************************************

Note: You have to be logged in as an Administrator to do this !

Edit the file etc\FurserDaemon.ini

[FurserDaemon]
Port=7117
Pass=somepassword
MaxClients=3
MaxLogFile=100000

Port: This is the listen port for the FurserDaemon. You will have to
      configure this port in such a way that it will be accessible through
      a firewall (if you have one). Do not use ports that are already in use
      or ports that are under 1024.

Pass: This is the password to the system. Use imagination and do not make it
      too short. Avoid special characters as these might not be possible to
      input from the client.

MaxClients: This is the number of simultaneous clients that can use the system.
MaxLogFile: This is the max size of the log file.


After editing the ini-file run the supplied ServiceInstall.cmd and after
that the ServiceStart.cmd. Your service is now running.


******************************************************************************
* Running as a process (easy):
******************************************************************************

Edit the file etc\FurserDaemon.ini

[FurserDaemon]
Port=7117
Pass=somepassword
MaxClients=3
MaxLogFile=100000

Port: This is the listen port for the FurserDaemon. You will have to
      configure this port in such a way that it will be accessible through
      a firewall (if you have one). Do not use ports that are already in use
      or ports that are under 1024.

Pass: This is the password to the system. Use imagination and do not make it
      too short. Avoid special characters as these might not be possible to
      input from the client.

MaxClients: This is the number of simultaneous clients that can use the system.
MaxLogFile: This is the max size of the log file.

After editing the ini-file run the supplied RunProcess.cmd.
Your service is now running.

******************************************************************************
* Advanced setup
******************************************************************************

You may run the FurserDaemon.exe in two modes; as a service or a process.

The advantage of running as a service is that the FurserDaemon will start up
automatically after reboot and does not need anyone to be logged in into the
system. You will need Administrator privileges to install FurserDaemon as
a service.

You may also run the FurserDaemon as a process. This has the disadvantage
that there must be an user session open (someone logged into the computer)
to run the FurserDaemon. The advantage in this mode is that you don't need
special privileges to run FurserDaemon in this mode.

You should note that FurserDaemon limits the number of running instances
to one. This is done to avoid possible lockups or similar situations. You
will be getting error messages if you try to circumvent this limitation.

When the FurserDaemon is installed as a service it will use a special
directory to store/read the config, log and data files. This directory
is located at your system folders in the following path:

%SystemRoot%\system32\drivers\etc\FurserDaemon

If you try to install a service and that path does not exist you will be
getting errors. You will need to put the FurserDaemon.ini file into that
location as well. It is also recommended to put the FurserDaemon.exe into
that location (although this is not nessecary) to protect it from an
accidental deletion.

After the ini-file is in the proper location you may install the service.
The service will use the executable that was used to install it - so if
you made a copy of the FurserDaemon.exe into the config location, use it
to install the service.


There is a way to get around from the default ini-file location. You can
change the location by setting an environment variable FURSERCONFDIR.
If this environment variable is set, the FurserDaemon will use the value
as the config location. This variable wil override as well the default
config path as well as the [config] commandline argument given for
commands run and settings.


If you make changes to the FurserDaemon.ini you must restart the service to
take the changes online. This config file is read only during the service or
process startup.

******************************************************************************
* Commandline
******************************************************************************

Here is a brief list of commandline arguments for the FurserDaemon.exe:

caninstall        Checks if the service can be installed
canremove         Checks if the service can be removed
install           Attempts to install the service
remove            Attempts to remove the service
start             Attempts to start the service
stop              Attempts to stop the service
pause             Attempts to pause the service
run [config]      Starts the FurserDaemon as a process
settings [config] Lists current settings
[config]          Optional configuration path

The ERRORLEVEL is 0 (zero) for succesful operation and 1 for errors.

Have fun !
