README.txt

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