README.txt

   1 NSSM: The Non-Sucking Service Manager\r
   2 Version 2.20, 2013-11-23\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://nssm.cc/\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 Since version 2.8, NSSM tries harder to shut down the managed application\r
  28 gracefully and throttles restart attempts if the application doesn't run\r
  29 for a minimum amount of time.\r
  30 \r
  31 Since version 2.11, NSSM respects srvany's AppEnvironment parameter.\r
  32 \r
  33 Since version 2.13, NSSM is translated into French.\r
  34 Thanks François-Régis Tardy.\r
  35 \r
  36 Since version 2.15, NSSM is translated into Italian.\r
  37 Thanks Riccardo Gusmeroli.\r
  38 \r
  39 Since version 2.17, NSSM can try to shut down console applications by\r
  40 simulating a Control-C keypress.  If they have installed a handler routine\r
  41 they can clean up and shut down gracefully on receipt of the event.\r
  42 \r
  43 Since version 2.17, NSSM can redirect the managed application's I/O streams\r
  44 to an arbitrary path.\r
  45 \r
  46 Since version 2.18, NSSM can be configured to wait a user-specified amount\r
  47 of time for the application to exit when shutting down.\r
  48 \r
  49 Since version 2.19, many more service options can be configured with the\r
  50 GUI installer as well as via the registry.\r
  51 \r
  52 Since version 2.19, NSSM can add to the service's environment by setting\r
  53 AppEnvironmentExtra in place of or in addition to the srvany-compatible\r
  54 AppEnvironment.\r
  55 \r
  56 \r
  57 Usage\r
  58 -----\r
  59 In the usage notes below, arguments to the program may be written in angle \r
  60 brackets and/or square brackets.  <string> means you must insert the \r
  61 appropriate string and [<string>] means the string is optional.  See the \r
  62 examples below...\r
  63 \r
  64 \r
  65 Installation using the GUI\r
  66 --------------------------\r
  67 To install a service, run\r
  68 \r
  69     nssm install <servicename>\r
  70 \r
  71 You will be prompted to enter the full path to the application you wish \r
  72 to run and any command line options to pass to that application.\r
  73 \r
  74 Use the system service manager (services.msc) to control advanced service \r
  75 properties such as startup method and desktop interaction.  NSSM may \r
  76 support these options at a later time...\r
  77 \r
  78 \r
  79 Installation using the command line\r
  80 -----------------------------------\r
  81 To install a service, run\r
  82 \r
  83     nssm install <servicename> <application> [<options>]\r
  84 \r
  85 NSSM will then attempt to install a service which runs the named application \r
  86 with the given options (if you specified any).\r
  87 \r
  88 Don't forget to enclose paths in "quotes" if they contain spaces!\r
  89 \r
  90 If you want to include quotes in the options you will need to """quote""" the\r
  91 quotes.\r
  92 \r
  93 \r
  94 Managing the service\r
  95 --------------------\r
  96 NSSM will launch the application listed in the registry when you send it a \r
  97 start signal and will terminate it when you send a stop signal.  So far, so \r
  98 much like srvany.  But NSSM is the Non-Sucking service manager and can take \r
  99 action if/when the application dies.\r
 100 \r
 101 With no configuration from you, NSSM will try to restart itself if it notices\r
 102 that the application died but you didn't send it a stop signal.  NSSM will\r
 103 keep trying, pausing between each attempt, until the service is successfully\r
 104 started or you send it a stop signal.\r
 105 \r
 106 NSSM will pause an increasingly longer time between subsequent restart attempts\r
 107 if the service fails to start in a timely manner, up to a maximum of four\r
 108 minutes.  This is so it does not consume an excessive amount of CPU time trying\r
 109 to start a failed application over and over again.  If you identify the cause\r
 110 of the failure and don't want to wait you can use the Windows service console\r
 111 (where the service will be shown in Paused state) to send a continue signal to\r
 112 NSSM and it will retry within a few seconds.\r
 113 \r
 114 By default, NSSM defines "a timely manner" to be within 1500 milliseconds.\r
 115 You can change the threshold for the service by setting the number of\r
 116 milliseconds as a REG_DWORD value in the registry at\r
 117 HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppThrottle.\r
 118 \r
 119 NSSM will look in the registry under\r
 120 HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit for\r
 121 string (REG_EXPAND_SZ) values corresponding to the exit code of the application.\r
 122 If the application exited with code 1, for instance, NSSM will look for a\r
 123 string value under AppExit called "1" or, if it does not find it, will\r
 124 fall back to the AppExit (Default) value.  You can find out the exit code\r
 125 for the application by consulting the system event log.  NSSM will log the\r
 126 exit code when the application exits.\r
 127 \r
 128 Based on the data found in the registry, NSSM will take one of three actions:\r
 129 \r
 130 If the value data is "Restart" NSSM will try to restart the application as\r
 131 described above.  This is its default behaviour.\r
 132 \r
 133 If the value data is "Ignore" NSSM will not try to restart the application\r
 134 but will continue running itself.  This emulates the (usually undesirable)\r
 135 behaviour of srvany.  The Windows Services console would show the service\r
 136 as still running even though the application has exited.\r
 137 \r
 138 If the value data is "Exit" NSSM will exit gracefully.  The Windows Services\r
 139 console would show the service as stopped.  If you wish to provide\r
 140 finer-grained control over service recovery you should use this code and\r
 141 edit the failure action manually.  Please note that Windows versions prior\r
 142 to Vista will not consider such an exit to be a failure.  On older versions\r
 143 of Windows you should use "Suicide" instead.\r
 144 \r
 145 If the value data is "Suicide" NSSM will simulate a crash and exit without\r
 146 informing the service manager.  This option should only be used for\r
 147 pre-Vista systems where you wish to apply a service recovery action.  Note\r
 148 that if the monitored application exits with code 0, NSSM will only honour a\r
 149 request to suicide if you explicitly configure a registry key for exit code 0.\r
 150 If only the default action is set to Suicide NSSM will instead exit gracefully.\r
 151 \r
 152 \r
 153 Stopping the service\r
 154 --------------------\r
 155 When stopping a service NSSM will attempt several different methods of killing\r
 156 the monitored application, each of which can be disabled if necessary.\r
 157 \r
 158 First NSSM will attempt to generate a Control-C event and send it to the\r
 159 application's console.  Batch scripts or console applications may intercept\r
 160 the event and shut themselves down gracefully.  GUI applications do not have\r
 161 consoles and will not respond to this method.\r
 162 \r
 163 Secondly NSSM will enumerate all windows created by the application and send\r
 164 them a WM_CLOSE message, requesting a graceful exit.\r
 165 \r
 166 Thirdly NSSM will enumerate all threads created by the application and send\r
 167 them a WM_QUIT message, requesting a graceful exit.  Not all applications'\r
 168 threads have message queues; those which do not will not respond to this\r
 169 method.\r
 170 \r
 171 Finally NSSM will call TerminateProcess() to request that the operating\r
 172 system forcibly terminate the application.  TerminateProcess() cannot be\r
 173 trapped or ignored, so in most circumstances the application will be killed.\r
 174 However, there is no guarantee that it will have a chance to perform any\r
 175 tidyup operations before it exits.\r
 176 \r
 177 Any or all of the methods above may be disabled.  NSSM will look for the\r
 178 HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppStopMethodSkip\r
 179 registry value which should be of type REG_DWORD set to a bit field describing\r
 180 which methods should not be applied.\r
 181 \r
 182   If AppStopMethodSkip includes 1, Control-C events will not be generated.\r
 183   If AppStopMethodSkip includes 2, WM_CLOSE messages will not be posted.\r
 184   If AppStopMethodSkip includes 4, WM_QUIT messages will not be posted.\r
 185   If AppStopMethodSkip includes 8, TerminateProcess() will not be called.\r
 186 \r
 187 If, for example, you knew that an application did not respond to Control-C\r
 188 events and did not have a thread message queue, you could set AppStopMethodSkip\r
 189 to 5 and NSSM would not attempt to use those methods to stop the application.\r
 190 \r
 191 Take great care when including 8 in the value of AppStopMethodSkip.  If NSSM\r
 192 does not call TerminateProcess() it is possible that the application will not\r
 193 exit when the service stops.\r
 194 \r
 195 By default NSSM will allow processes 1500ms to respond to each of the methods\r
 196 described above before proceeding to the next one.  The timeout can be\r
 197 configured on a per-method basis by creating REG_DWORD entries in the\r
 198 registry under HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters.\r
 199 \r
 200   AppStopMethodConsole\r
 201   AppStopMethodWindow\r
 202   AppStopMethodThreads\r
 203 \r
 204 Each value should be set to the number of milliseconds to wait.  Please note\r
 205 that the timeout applies to each process in the application's process tree,\r
 206 so the actual time to shutdown may be longer than the sum of all configured\r
 207 timeouts if the application spawns multiple subprocesses.\r
 208 \r
 209 \r
 210 I/O redirection\r
 211 ---------------\r
 212 NSSM can redirect the managed application's I/O to any path capable of being\r
 213 opened by CreateFile().  This enables, for example, capturing the log output\r
 214 of an application which would otherwise only write to the console or accepting\r
 215 input from a serial port.\r
 216 \r
 217 NSSM will look in the registry under\r
 218 HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters for the keys\r
 219 corresponding to arguments to CreateFile().  All are optional.  If no path is\r
 220 given for a particular stream it will not be redirected.  If a path is given\r
 221 but any of the other values are omitted they will be receive sensible defaults.\r
 222 \r
 223   AppStdin: Path to receive input.\r
 224   AppStdout: Path to receive output.\r
 225   AppStderr: Path to receive error output.\r
 226 \r
 227 Parameters for CreateFile() are providing with the "AppStdinShareMode",\r
 228 "AppStdinCreationDisposition" and "AppStdinFlagsAndAttributes" values (and\r
 229 analogously for stdout and stderr).\r
 230 \r
 231 In general, if you want the service to log its output, set AppStdout and\r
 232 AppStderr to the same path, eg C:\Users\Public\service.log, and it should\r
 233 work.  Remember, however, that the path must be accessible to the user\r
 234 running the service.\r
 235 \r
 236 \r
 237 Environment variables\r
 238 ---------------------\r
 239 NSSM can replace or append to the managed application's environment.  Two\r
 240 multi-valued string (REG_MULTI_SZ) registry values are recognised under\r
 241 HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters.\r
 242 \r
 243 AppEnvironment defines a list of environment variables which will override\r
 244 the service's environment.  AppEnvironmentExtra defines a list of\r
 245 environment variables which will be added to the service's environment.\r
 246 \r
 247 Each entry in the list should be of the form KEY=VALUE.  It is possible to\r
 248 omit the VALUE but the = symbol is mandatory.\r
 249 \r
 250 srvany only supports AppEnvironment.\r
 251 \r
 252 \r
 253 Removing services using the GUI\r
 254 -------------------------------\r
 255 NSSM can also remove services.  Run\r
 256 \r
 257     nssm remove <servicename>\r
 258 \r
 259 to remove a service.  You will prompted for confirmation before the service \r
 260 is removed.  Try not to remove essential system services...\r
 261 \r
 262 \r
 263 Removing service using the command line\r
 264 ---------------------------------------\r
 265 To remove a service without confirmation from the GUI, run\r
 266 \r
 267     nssm remove <servicename> confirm\r
 268 \r
 269 Try not to remove essential system services...\r
 270 \r
 271 \r
 272 Logging\r
 273 -------\r
 274 NSSM logs to the Windows event log.  It registers itself as an event log source\r
 275 and uses unique event IDs for each type of message it logs.  New versions may\r
 276 add event types but existing event IDs will never be changed.\r
 277 \r
 278 Because of the way NSSM registers itself you should be aware that you may not\r
 279 be able to replace the NSSM binary if you have the event viewer open and that\r
 280 running multiple instances of NSSM from different locations may be confusing if\r
 281 they are not all the same version.\r
 282 \r
 283 \r
 284 Example usage\r
 285 -------------\r
 286 To install an Unreal Tournament server:\r
 287 \r
 288     nssm install UT2004 c:\games\ut2004\system\ucc.exe server\r
 289 \r
 290 To remove the server:\r
 291 \r
 292     nssm remove UT2004 confirm\r
 293 \r
 294 \r
 295 Building NSSM from source\r
 296 -------------------------\r
 297 NSSM is known to compile with Visual Studio 6, Visual Studio 2005 and Visual\r
 298 Studio 2008.\r
 299 \r
 300 NSSM will also compile with Visual Studio 2010 but the resulting executable\r
 301 will not run on versions of Windows older than XP SP2.\r
 302 \r
 303 \r
 304 Credits\r
 305 -------\r
 306 Thanks to Bernard Loh for finding a bug with service recovery.\r
 307 Thanks to Benjamin Mayrargue (www.softlion.com) for adding 64-bit support.\r
 308 Thanks to Joel Reingold for spotting a command line truncation bug.\r
 309 Thanks to Arve Knudsen for spotting that child processes of the monitored\r
 310 application could be left running on service shutdown, and that a missing\r
 311 registry value for AppDirectory confused NSSM.\r
 312 Thanks to Peter Wagemans and Laszlo Keresztfalvi for suggesting throttling restarts.\r
 313 Thanks to Eugene Lifshitz for finding an edge case in CreateProcess() and for\r
 314 advising how to build messages.mc correctly in paths containing spaces.\r
 315 Thanks to Rob Sharp for pointing out that NSSM did not respect the\r
 316 AppEnvironment registry value used by srvany.\r
 317 Thanks to Szymon Nowak for help with Windows 2000 compatibility.\r
 318 Thanks to François-Régis Tardy for French translation.\r
 319 Thanks to Emilio Frini for spotting that French was inadvertently set as\r
 320 the default language when the user's display language was not translated.\r
 321 Thanks to Riccardo Gusmeroli for Italian translation.\r
 322 Thanks to Eric Cheldelin for the inspiration to generate a Control-C event\r
 323 on shutdown.\r
 324 Thanks to Brian Baxter for suggesting how to escape quotes from the command prompt.\r
 325 Thanks to Russ Holmann for suggesting that the shutdown timeout be configurable.\r
 326 Thanks to Paul Spause for spotting a bug with default registry entries.\r
 327 \r
 328 Licence\r
 329 -------\r
 330 NSSM is public domain.  You may unconditionally use it and/or its source code \r
 331 for any purpose you wish.\r