Print This Page

Cli based installer

Command-line version (v2.0 released 15/08/2004)


Installation instructions (using default values):

  1. Download the CLI based F@H Service installer package
  2. Extract the package to a temporary installation folder. Note: Do not use an existing F@H client install folder as this will cause an error when running the service installer
  3. Either download FAH500-Console.exe from the Stanford folding website and place it in the temporary installation directory or use the download client switch (see below).
  4. Run service.exe
  5. Configure the client (Team Egg Roll is team #14)
  6. The F@H client will then be installed into "c:\fah1" and a service will be created called "FAH1". The client will run with only the "-service" switch
  7. An uninstall script will be generated which will remove the F@H service
  8. Type "net start FAH1" into the run dialog or at a command prompt to start the service

Installation instructions (using command-line switches):

  1. Download the CLI based F@H Service installer package.
  2. Extract the package to a temporary installation folder. Note: Do not use an existing F@H client install folder as this will cause an error when running the service installer.
  3. Either download FAH500-Console.exe from the Stanford folding website and place it in the temporary installation directory or use the download client switch (see below).
  4. Run service.exe using any of the following command-line switches:
  5. Additional options:
    • If you want to use an existing client.cfg file then place that file in the temporary install directory and use the -noconfig switch
    • If the machine has more than one CPU (or you want to install more than one service client) then use the -cpu=n switch where n can be 1,2,3 or 4
    • If you want to install to different directories to the defaults (c:\fah1, c:\fah2, etc) then use the -dir="service_dir" switch. The service_dir value will be followed by the number of the client
    • If you want to use a different name for the service other than the default names (FAH1, FAH2, etc) then use the -sn="service_name" switch. The service_name value will be followed by the number fo the client
    • If you want the clients to use parameters additional to the defaults (-service -local) then use the -params="parameters" switch. Note: The string entered between the quotes will be the exact string of parameters passed to the client when it is launched therefore you will need to include the hythen in front of the parameter name (eg -params="-advmethods -forceasm")
    • If you want the services to be started automatically then specify the -startservices switch
  6. Configure the client if necessary (Team Egg Roll is team #14). If you are using the "-noconfig" switch and it fails then you installer will error then exit
  7. The F@H client will then be installed as a service using the specified values or where necessary, the defaults
  8. An uninstall script will ne generated which will remove the service(s).
  9. Type "net start (service_name)+(client_number)" into the run dialog or at a command prompt to start the services (eg if default service name is used, "net start F@H1" to start the first client)

To view the information below, type service.exe -? at a command prompt

Command line switches:

-cpu=n               : number of client installs (max of 8)
defaults to 1 if undefined
-dir="path" : location to install clients
defaults to c:\fah[1..n] if undefined
-sn="service name" : name of service
defaults to FAH[1..n] if undefined
-params="parameters" : client startup parameters (do not include "-service")
Note: include the "-" before the parameter
defaults to just "-service" if undefined
-clientexe="exename" : name of the console client executable
defaults to FAH500-Console.exe if undefined
-noconfig : use existing config file
place config file in same dir as this exe
-downloadclient="uri": downloads the client from the specified uri
-startservices : start the service(s) after install

By default the F@H client service will be installed once to directory "c:\fah1", the service will be called "FAH1" and the serviced client won't use any additional command line switches with a client executable called "FAH500-Console.exe"

Example service install command: service -cpu=2 -dir="c:\f@h\client" -sn="Folding@Home" -params="-forceasm" -clientexe="FAH5.exe"

This will install the F@H client into two seperate directories ("c:\f@h\client1" & "c:\f@h\client2") and install one service per directory with the services called Folding@Home1 and Folding@Home2. The executable launched by the service is called FAH5.exe The clients will be started using the switch -forceasm.