README.txt

   1 NSSM: The Non-Sucking Service Manager\r
   2 Version 2.16, 2012-12-01\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 \r
  47 Usage\r
  48 -----\r
  49 In the usage notes below, arguments to the program may be written in angle \r
  50 brackets and/or square brackets.  <string> means you must insert the \r
  51 appropriate string and [<string>] means the string is optional.  See the \r
  52 examples below...\r
  53 \r
  54 \r
  55 Installation using the GUI\r
  56 --------------------------\r
  57 To install a service, run\r
  58 \r
  59     nssm install <servicename>\r
  60 \r
  61 You will be prompted to enter the full path to the application you wish \r
  62 to run and any command line options to pass to that application.\r
  63 \r
  64 Use the system service manager (services.msc) to control advanced service \r
  65 properties such as startup method and desktop interaction.  NSSM may \r
  66 support these options at a later time...\r
  67 \r
  68 \r
  69 Installation using the command line\r
  70 -----------------------------------\r
  71 To install a service, run\r
  72 \r
  73     nssm install <servicename> <application> [<options>]\r
  74 \r
  75 NSSM will then attempt to install a service which runs the named application \r
  76 with the given options (if you specified any).\r
  77 \r
  78 Don't forget to enclose paths in "quotes" if they contain spaces!\r
  79 \r
  80 \r
  81 Managing the service\r
  82 --------------------\r
  83 NSSM will launch the application listed in the registry when you send it a \r
  84 start signal and will terminate it when you send a stop signal.  So far, so \r
  85 much like srvany.  But NSSM is the Non-Sucking service manager and can take \r
  86 action if/when the application dies.\r
  87 \r
  88 With no configuration from you, NSSM will try to restart itself if it notices\r
  89 that the application died but you didn't send it a stop signal.  NSSM will\r
  90 keep trying, pausing between each attempt, until the service is successfully\r
  91 started or you send it a stop signal.\r
  92 \r
  93 NSSM will pause an increasingly longer time between subsequent restart attempts\r
  94 if the service fails to start in a timely manner, up to a maximum of four\r
  95 minutes.  This is so it does not consume an excessive amount of CPU time trying\r
  96 to start a failed application over and over again.  If you identify the cause\r
  97 of the failure and don't want to wait you can use the Windows service console\r
  98 (where the service will be shown in Paused state) to send a continue signal to\r
  99 NSSM and it will retry within a few seconds.\r
 100 \r
 101 By default, NSSM defines "a timely manner" to be within 1500 milliseconds.\r
 102 You can change the threshold for the service by setting the number of\r
 103 milliseconds as a REG_DWORD value in the registry at\r
 104 HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppThrottle.\r
 105 \r
 106 NSSM will look in the registry under\r
 107 HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit for\r
 108 string (REG_EXPAND_SZ) values corresponding to the exit code of the application.\r
 109 If the application exited with code 1, for instance, NSSM will look for a\r
 110 string value under AppExit called "1" or, if it does not find it, will\r
 111 fall back to the AppExit (Default) value.  You can find out the exit code\r
 112 for the application by consulting the system event log.  NSSM will log the\r
 113 exit code when the application exits.\r
 114 \r
 115 Based on the data found in the registry, NSSM will take one of three actions:\r
 116 \r
 117 If the value data is "Restart" NSSM will try to restart the application as\r
 118 described above.  This is its default behaviour.\r
 119 \r
 120 If the value data is "Ignore" NSSM will not try to restart the application\r
 121 but will continue running itself.  This emulates the (usually undesirable)\r
 122 behaviour of srvany.  The Windows Services console would show the service\r
 123 as still running even though the application has exited.\r
 124 \r
 125 If the value data is "Exit" NSSM will exit gracefully.  The Windows Services\r
 126 console would show the service as stopped.  If you wish to provide\r
 127 finer-grained control over service recovery you should use this code and\r
 128 edit the failure action manually.  Please note that Windows versions prior\r
 129 to Vista will not consider such an exit to be a failure.  On older versions\r
 130 of Windows you should use "Suicide" instead.\r
 131 \r
 132 If the value data is "Suicide" NSSM will simulate a crash and exit without\r
 133 informing the service manager.  This option should only be used for\r
 134 pre-Vista systems where you wish to apply a service recovery action.  Note\r
 135 that if the monitored application exits with code 0, NSSM will only honour a\r
 136 request to suicide if you explicitly configure a registry key for exit code 0.\r
 137 If only the default action is set to Suicide NSSM will instead exit gracefully.\r
 138 \r
 139 \r
 140 I/O redirection\r
 141 ---------------\r
 142 NSSM can redirect the managed application's I/O to any path capable of being\r
 143 opened by CreateFile().  This enables, for example, capturing the log output\r
 144 of an application which would otherwise only write to the console or accepting\r
 145 input from a serial port.\r
 146 \r
 147 NSSM will look in the registry under\r
 148 HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters for the keys\r
 149 corresponding to arguments to CreateFile().  All are optional.  If no path is\r
 150 given for a particular stream it will not be redirected.  If a path is given\r
 151 but any of the other values are omitted they will be receive sensible defaults.\r
 152 \r
 153   AppStdin: Path to receive input.\r
 154   AppStdout: Path to receive output.\r
 155   AppStderr: Path to receive error output.\r
 156 \r
 157 Parameters for CreateFile() are providing with the "AppStdinShareMode",\r
 158 "AppStdinCreationDisposition" and "AppStdinFlagsAndAttributes" values (and\r
 159 analogously for stdout and stderr).\r
 160 \r
 161 In general, if you want the service to log its output, set AppStdout and\r
 162 AppStderr to the same path, eg C:\Users\Public\service.log, and it should\r
 163 work.  Remember, however, that the path must be accessible to the user\r
 164 running the service.\r
 165 \r
 166 \r
 167 Removing services using the GUI\r
 168 -------------------------------\r
 169 NSSM can also remove services.  Run\r
 170 \r
 171     nssm remove <servicename>\r
 172 \r
 173 to remove a service.  You will prompted for confirmation before the service \r
 174 is removed.  Try not to remove essential system services...\r
 175 \r
 176 \r
 177 Removing service using the command line\r
 178 ---------------------------------------\r
 179 To remove a service without confirmation from the GUI, run\r
 180 \r
 181     nssm remove <servicename> confirm\r
 182 \r
 183 Try not to remove essential system services...\r
 184 \r
 185 \r
 186 Logging\r
 187 -------\r
 188 NSSM logs to the Windows event log.  It registers itself as an event log source\r
 189 and uses unique event IDs for each type of message it logs.  New versions may\r
 190 add event types but existing event IDs will never be changed.\r
 191 \r
 192 Because of the way NSSM registers itself you should be aware that you may not\r
 193 be able to replace the NSSM binary if you have the event viewer open and that\r
 194 running multiple instances of NSSM from different locations may be confusing if\r
 195 they are not all the same version.\r
 196 \r
 197 \r
 198 Example usage\r
 199 -------------\r
 200 To install an Unreal Tournament server:\r
 201 \r
 202     nssm install UT2004 c:\games\ut2004\system\ucc.exe server\r
 203 \r
 204 To remove the server:\r
 205 \r
 206     nssm remove UT2004 confirm\r
 207 \r
 208 \r
 209 Building NSSM from source\r
 210 -------------------------\r
 211 NSSM is known to compile with Visual Studio 6, Visual Studio 2005 and Visual\r
 212 Studio 2008.\r
 213 \r
 214 NSSM will also compile with Visual Studio 2010 but the resulting executable\r
 215 will not run on versions of Windows older than XP SP2.\r
 216 \r
 217 \r
 218 Credits\r
 219 -------\r
 220 Thanks to Bernard Loh for finding a bug with service recovery.\r
 221 Thanks to Benjamin Mayrargue (www.softlion.com) for adding 64-bit support.\r
 222 Thanks to Joel Reingold for spotting a command line truncation bug.\r
 223 Thanks to Arve Knudsen for spotting that child processes of the monitored\r
 224 application could be left running on service shutdown, and that a missing\r
 225 registry value for AppDirectory confused NSSM.\r
 226 Thanks to Peter Wagemans and Laszlo Keresztfalvi for suggesting throttling restarts.\r
 227 Thanks to Eugene Lifshitz for finding an edge case in CreateProcess() and for\r
 228 advising how to build messages.mc correctly in paths containing spaces.\r
 229 Thanks to Rob Sharp for pointing out that NSSM did not respect the\r
 230 AppEnvironment registry value used by srvany.\r
 231 Thanks to Szymon Nowak for help with Windows 2000 compatibility.\r
 232 Thanks to François-Régis Tardy for French translation.\r
 233 Thanks to Emilio Frini for spotting that French was inadvertently set as\r
 234 the default language when the user's display language was not translated.\r
 235 Thanks to Riccardo Gusmeroli for Italian translation.\r
 236 Thanks to Eric Cheldelin for the inspiration to generate a Control-C event\r
 237 on shutdown.\r
 238 \r
 239 Licence\r
 240 -------\r
 241 NSSM is public domain.  You may unconditionally use it and/or its source code \r
 242 for any purpose you wish.\r