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