README.txt

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