More robust options for controlling a service.
[nssm.git] / ChangeLog.txt
1 Changes since 2.21
2 ------------------
3   * Existing services can now be managed using the GUI
4     or on the command line.
5
6   * NSSM can now set the priority class and processor
7     affinity of the managed application.
8
9   * NSSM can now apply an unconditional delay before
10     restarting the application.
11
12   * NSSM can now optionally rotate existing files when
13     redirecting I/O.
14
15   * Unqualified path names are now relative to the
16     application startup directory when redirecting I/O.
17
18   * NSSM can now set the service display name, description,
19     startup type and log on details.
20
21 Changes since 2.20
22 ------------------
23   * Services installed from the GUI no longer have incorrect
24     AppParameters set in the registry.
25
26 Changes since 2.19
27 ------------------
28   * Services installed from the commandline without using the
29     GUI no longer have incorrect AppStopMethod* registry
30     entries set.
31
32 Changes since 2.18
33 ------------------
34   * Support AppEnvironmentExtra to append to the environment
35     instead of replacing it.
36
37   * The GUI is significantly less sucky.
38
39 Changes since 2.17
40 ------------------
41   * Timeouts for each shutdown method can be configured in
42     the registry.
43
44   * The GUI is slightly less sucky.
45
46 Changes since 2.16
47 ------------------
48   * NSSM can now redirect the service's I/O streams to any path
49     capable of being opened by CreateFile().
50
51   * Allow building on Visual Studio Express.
52
53   * Silently ignore INTERROGATE control.
54
55   * Try to send Control-C events to console applications when
56     shutting them down.
57
58 Changes since 2.15
59 ------------------
60   * Fixed case where NSSM could kill unrelated processes when
61     shutting down.
62
63 Changes since 2.14
64 ------------------
65   * NSSM is now translated into Italian.
66
67   * Fixed GUI not allowing paths longer than 256 characters.
68
69 Changes since 2.13
70 ------------------
71   * Fixed default GUI language being French not English.
72
73 Changes since 2.12
74 ------------------
75   * Fixed failure to run on Windows 2000.
76
77 Changes since 2.11
78 ------------------
79   * NSSM is now translated into French.
80
81   * Really ensure systems recovery actions can happen.
82
83     The change supposedly introduced in v2.4 to allow service recovery
84     actions to be activated when the application exits gracefully with
85     a non-zero error code didn't actually work.
86
87 Changes since 2.10
88 ------------------
89   * Support AppEnvironment for compatibility with srvany.
90
91 Changes since 2.9
92 -----------------
93   * Fixed failure to compile messages.mc in paths containing spaces.
94
95   * Fixed edge case with CreateProcess().
96
97     Correctly handle the case where the application executable is under
98     a path which contains space and an executable sharing the initial
99     part of that path (up to a space) exists.
100
101 Changes since 2.8
102 -----------------
103   * Fixed failure to run on Windows versions prior to Vista.
104
105 Changes since 2.7
106 -----------------
107   * Read Application, AppDirectory and AppParameters before each restart so
108     a change to any one doesn't require restarting NSSM itself.
109
110   * Fixed messages not being sent to the event log correctly in some
111     cases.
112
113   * Try to handle (strictly incorrect) quotes in AppDirectory.
114
115     Windows directories aren't allowed to contain quotes so CreateProcess()
116     will fail if the AppDirectory is quoted.  Note that it succeeds even if
117     Application itself is quoted as the application plus parameters are
118     interpreted as a command line.
119
120   * Fixed failed to write full arguments to AppParameters when
121     installing a service.
122
123   * Throttle restarts.
124
125     Back off from restarting the application immediately if it starts
126     successfully but exits too soon.  The default value of "too soon" is
127     1500 milliseconds.  This can be configured by adding a DWORD value
128     AppThrottle to the registry.
129     
130     Handle resume messages from the service console to restart the
131     application immediately even if it is throttled.
132
133   * Try to kill the process tree gracefully.
134
135     Before calling TerminateProcess() on all processes assocatiated with
136     the monitored application, enumerate all windows and threads and
137     post appropriate messages to them.  If the application bothers to
138     listen for such messages it has a chance to shut itself down gracefully.
139
140 Changes since 2.6
141 -----------------
142   * Handle missing registry values.
143
144     Warn if AppParameters is missing.  Warn if AppDirectory is missing or
145     unset and choose a fallback directory.
146     First try to find the parent directory of the application.  If that
147     fails, eg because the application path is just "notepad" or something,
148     start in the Windows directory.
149
150   * Kill process tree when stopping service.
151
152     Ensure that all child processes of the monitored application are
153     killed when the service stops by recursing through all running
154     processes and terminating those whose parent is the application
155     or one of its descendents.
156
157 Changes since 2.5
158 -----------------
159   * Removed incorrect ExpandEnvironmentStrings() error.
160
161     A log_event() call was inadvertently left in the code causing an error
162     to be set to the eventlog saying that ExpandEnvironmentStrings() had
163     failed when it had actually succeeded.
164
165 Changes since 2.4
166 -----------------
167   * Allow use of REG_EXPAND_SZ values in the registry.
168
169   * Don't suicide on exit status 0 by default.
170
171     Suiciding when the application exits 0 will cause recovery actions to be
172     taken.  Usually this is inappropriate.  Only suicide if there is an
173     explicit AppExit value for 0 in the registry.
174     
175     Technically such behaviour could be abused to do something like run a
176     script after successful completion of a service but in most cases a
177     suicide is undesirable when no actual failure occurred.
178
179   * Don't hang if startup parameters couldn't be determined.
180     Instead, signal that the service entered the STOPPED state.
181     Set START_PENDING state prior to actual startup.
182
183 Changes since 2.3
184 -----------------
185   * Ensure systems recovery actions can happen.
186
187     In Windows versions earlier than Vista the service manager would only
188     consider a service failed (and hence eligible for recovery action) if
189     the service exited without setting its state to SERVICE_STOPPED, even if
190     it signalled an error exit code.
191     In Vista and later the service manager can be configured to treat a
192     graceful shutdown with error code as a failure but this is not the
193     default behaviour.
194
195     Try to configure the service manager to use the new behaviour when
196     starting the service so users who set AppExit to Exit can use recovery
197     actions as expected.
198
199     Also recognise the new AppExit option Suicide for use on pre-Vista
200     systems.  When AppExit is Suicide don't stop the service but exit
201     inelegantly, which should be seen as a failure.
202
203 Changes since 2.2
204 -----------------
205   * Send properly formatted messages to the event log.
206
207   * Fixed truncation of very long path lengths in the registry.
208
209 Changes since 2.1
210 -----------------
211  *  Decide how to handle application exit.
212
213     When the service exits with exit code n look in
214     HKLM\SYSTEM\CurrentControlSet\Services\<service>\Parameters\AppExit\<n>,
215     falling back to the unnamed value if no such code is listed.  Parse the
216     (string) value of this entry as follows:
217
218         Restart: Start the application again (NSSM default).
219         Ignore:  Do nothing (srvany default).
220         Exit:    Stop the service.
221
222 Changes since 2.0
223 -----------------
224   * Added support for building a 64-bit executable. 
225
226   * Added project files for newer versions of Visual Studio.