README.txt

   1 NSSM: The Non-Sucking Service Manager\r
   2 Version 2.7, 2011-01-25\r
   3 \r
   4 NSSM is a service helper program similar to srvany and cygrunsrv.  It can \r
   5 start any application as an NT service and will restart the service if it \r
   6 fails for any reason.\r
   7 \r
   8 NSSM also has a graphical service installer and remover.\r
   9 \r
  10 Full documentation can be found online at\r
  11 \r
  12                            http://iain.cx/src/nssm/\r
  13 \r
  14 Since version 2.0, the GUI can be bypassed by entering all appropriate \r
  15 options on the command line.\r
  16 \r
  17 Since version 2.1, NSSM can be compiled for x64 platforms.\r
  18 Thanks Benjamin Mayrargue.\r
  19 \r
  20 Since version 2.2, NSSM can be configured to take different actions\r
  21 based on the exit code of the managed application.\r
  22 \r
  23 Since version 2.3, NSSM logs to the Windows event log more elegantly.\r
  24 \r
  25 Since version 2.5, NSSM respects environment variables in its parameters.\r
  26 \r
  27 \r
  28 Usage\r
  29 -----\r
  30 In the usage notes below, arguments to the program may be written in angle \r
  31 brackets and/or square brackets.  <string> means you must insert the \r
  32 appropriate string and [<string>] means the string is optional.  See the \r
  33 examples below...\r
  34 \r
  35 \r
  36 Installation using the GUI\r
  37 --------------------------\r
  38 To install a service, run\r
  39 \r
  40     nssm install <servicename>\r
  41 \r
  42 You will be prompted to enter the full path to the application you wish \r
  43 to run and any command line options to pass to that application.\r
  44 \r
  45 Use the system service manager (services.msc) to control advanced service \r
  46 properties such as startup method and desktop interaction.  NSSM may \r
  47 support these options at a later time...\r
  48 \r
  49 \r
  50 Installation using the command line\r
  51 -----------------------------------\r
  52 To install a service, run\r
  53 \r
  54     nssm install <servicename> <application> [<options>]\r
  55 \r
  56 NSSM will then attempt to install a service which runs the named application \r
  57 with the given options (if you specified any).\r
  58 \r
  59 Don't forget to enclose paths in "quotes" if they contain spaces!\r
  60 \r
  61 \r
  62 Managing the service\r
  63 --------------------\r
  64 NSSM will launch the application listed in the registry when you send it a \r
  65 start signal and will terminate it when you send a stop signal.  So far, so \r
  66 much like srvany.  But NSSM is the Non-Sucking service manager and can take \r
  67 action if/when the application dies.\r
  68 \r
  69 With no configuration from you, NSSM will try to restart itself if it notices\r
  70 that the application died but you didn't send it a stop signal.  NSSM will\r
  71 keep trying, pausing between each attempt, until the service is successfully\r
  72 started or you send it a stop signal.\r
  73 \r
  74 NSSM will pause an increasingly longer time between subsequent restart attempts\r
  75 if the service fails to start in a timely manner, up to a maximum of four\r
  76 minutes.  This is so it does not consume an excessive amount of CPU time trying\r
  77 to start a failed application over and over again.  If you identify the cause\r
  78 of the failure and don't want to wait you can use the Windows service console\r
  79 (where the service will be shown in Paused state) to send a continue signal to\r
  80 NSSM and it will retry within a few seconds.\r
  81 \r
  82 By default, NSSM defines "a timely manner" to be within 1500 milliseconds.\r
  83 You can change the threshold for the service by setting the number of\r
  84 milliseconds as a REG_DWORD value in the registry at\r
  85 HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppThrottle.\r
  86 \r
  87 NSSM will look in the registry under\r
  88 HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit for\r
  89 string (REG_EXPAND_SZ) values corresponding to the exit code of the application.\r
  90 If the application exited with code 1, for instance, NSSM will look for a\r
  91 string value under AppExit called "1" or, if it does not find it, will\r
  92 fall back to the AppExit (Default) value.  You can find out the exit code\r
  93 for the application by consulting the system event log.  NSSM will log the\r
  94 exit code when the application exits.\r
  95 \r
  96 Based on the data found in the registry, NSSM will take one of three actions:\r
  97 \r
  98 If the value data is "Restart" NSSM will try to restart the application as\r
  99 described above.  This is its default behaviour.\r
 100 \r
 101 If the value data is "Ignore" NSSM will not try to restart the application\r
 102 but will continue running itself.  This emulates the (usually undesirable)\r
 103 behaviour of srvany.  The Windows Services console would show the service\r
 104 as still running even though the application has exited.\r
 105 \r
 106 If the value data is "Exit" NSSM will exit gracefully.  The Windows Services\r
 107 console would show the service as stopped.  If you wish to provide\r
 108 finer-grained control over service recovery you should use this code and\r
 109 edit the failure action manually.  Please note that Windows versions prior\r
 110 to Vista will not consider such an exit to be a failure.  On older versions\r
 111 of Windows you should use "Suicide" instead.\r
 112 \r
 113 If the value data is "Suicide" NSSM will simulate a crash and exit without\r
 114 informing the service manager.  This option should only be used for\r
 115 pre-Vista systems where you wish to apply a service recovery action.  Note\r
 116 that if the monitored application exits with code 0, NSSM will only honour a\r
 117 request to suicide if you explicitly configure a registry key for exit code 0.\r
 118 If only the default action is set to Suicide NSSM will instead exit gracefully.\r
 119 \r
 120 \r
 121 Removing services using the GUI\r
 122 -------------------------------\r
 123 NSSM can also remove services.  Run\r
 124 \r
 125     nssm remove <servicename>\r
 126 \r
 127 to remove a service.  You will prompted for confirmation before the service \r
 128 is removed.  Try not to remove essential system services...\r
 129 \r
 130 \r
 131 Removing service using the command line\r
 132 ---------------------------------------\r
 133 To remove a service without confirmation from the GUI, run\r
 134 \r
 135     nssm remove <servicename> confirm\r
 136 \r
 137 Try not to remove essential system services...\r
 138 \r
 139 \r
 140 Logging\r
 141 -------\r
 142 NSSM logs to the Windows event log.  It registers itself as an event log source\r
 143 and uses unique event IDs for each type of message it logs.  New versions may\r
 144 add event types but existing event IDs will never be changed.\r
 145 \r
 146 Because of the way NSSM registers itself you should be aware that you may not\r
 147 be able to replace the NSSM binary if you have the event viewer open and that\r
 148 running multiple instances of NSSM from different locations may be confusing if\r
 149 they are not all the same version.\r
 150 \r
 151 \r
 152 Example usage\r
 153 -------------\r
 154 To install an Unreal Tournament server:\r
 155 \r
 156     nssm install UT2004 c:\games\ut2004\system\ucc.exe server\r
 157 \r
 158 To remove the server:\r
 159 \r
 160     nssm remove UT2004 confirm\r
 161 \r
 162 \r
 163 Building NSSM from source\r
 164 -------------------------\r
 165 NSSM is known to compile with Visual Studio 6, Visual Studio 2005 and Visual\r
 166 Studio 2008.\r
 167 \r
 168 \r
 169 Credits\r
 170 -------\r
 171 Thanks to Bernard Loh for finding a bug with service recovery.\r
 172 Thanks to Benjamin Mayrargue (www.softlion.com) for adding 64-bit support.\r
 173 Thanks to Joel Reingold for spotting a command line truncation bug.\r
 174 Thanks to Arve Knudsen for spotting that child processes of the monitored\r
 175 application could be left running on service shutdown, and that a missing\r
 176 registry value for AppDirectory confused NSSM.\r
 177 Thanks to Peter Wagemans and Laszlo Kereszt for suggesting throttling restarts.\r
 178 \r
 179 Licence\r
 180 -------\r
 181 NSSM is public domain.  You may unconditionally use it and/or its source code \r
 182 for any purpose you wish.\r