4 This is the README for Dinit, the service manager and init system. It is
5 intended to provide an overview; For full documentation please check the manual pages.
9 1. [Introduction](#introduction)
10 2. [Configuring services](#configuring-services)
11 1. [Service types](#service-types)
12 2. [Service description files](#service-description-files)
13 3. [Controlling services](#controlling-services)
14 1. [Service hierarchy and states](#service-hierarchy-and-states)
15 2. [Using dinitctl](#using-dinitctl)
19 "Dinit" is a service supervisor with dependency support which can also
20 act as the system "init" program. It was created with the intention of
21 providing a portable init system that could serve as a lighter-weight
22 alternative to the Linux-only Systemd.
24 Specifically, Dinit can launch multiple services in parallel, with dependency
25 management (i.e. if one service's operation depends on another, the latter
26 service will be started first). It can monitor the process corresponding to a
27 service, and re-start it if it dies, and it can do this in an intelligent way,
28 first "rolling back" all dependent services, and restarting them when their
29 dependencies are satisfied. However, the precise nature of dependency
30 relations between services is highly configurable.
32 Dinit includes "dinitctl", a tool to issue commands to the main Dinit
33 process in order to start or stop services and check their state, as well as
34 a "shutdown" program (with scripts "halt" and "reboot") to manage shutting
35 down and restarting the system.
37 Dinit is designed to work on POSIXy operating systems such as Linux and
38 OpenBSD. It is written in C++ and uses the [Dasynq](http://davmac.org/projects/dasynq/)
39 event handling library, which was written especially to support Dinit.
41 Development goals include clean design, robustness, portability, and
42 avoiding feature bloat (whilst still handling a variety of use cases).
44 See [doc/COMPARISON](doc/COMPARISON) for a comparison of Dinit with similar
47 Dinit is licensed under the Apache License, version 2.0. A copy of this
48 license can be found in the LICENSE file.
50 Dinit was written by Davin McCall <davmac@davmac.org>.
52 See BUILD for information on how to build Dinit.
55 ## Configuring services
59 A "service" is nominally a persistent process or system state. The two main
60 types of service are a _process_ service (represented by a an actual process)
61 and a _scripted_ service (which is started and stopped by running a process -
62 often a shell script - to completion). There are also _bgprocess_ services
63 and _internal_ services.
65 Many programs that you might want to run under Dinit's supervision can run
66 either "in the foreground" or as a daemon ("in the background"), and the
67 choice is dictated by a command line switch (for instance the -D and -F
68 switches to Samba's "smbd"). Although it might seem counterintuitive,
69 the "foreground" mode should be used for programs registered as process
70 services in Dinit; this allows Dinit to monitor the process.
72 Process services are attractive due to the ease of monitoring (and
73 restarting) the service, however, they have one inherent problem, which is
74 that Dinit cannot tell when the service is truly started. Once the process
75 has been launched, Dinit assumes that the service has started, but in fact
76 there will be a short delay before the process sets itself up, starts
77 listening on sockets, etc; during this time any other process (including
78 one from a service listed as dependent) which tries to contact it will not
79 be able to do so. In practice, this is not usually a problem (and external
80 solutions, like D-Bus, do exist).
82 A _scripted_ service has separate commands for startup and (optional)
83 shutdown. Scripted services can be used for tasks such as mounting file
84 systems that don't need a persistent process, and in some cases can be used
85 for daemon processes (although Dinit will not be able to supervise a
86 process that is registered as a scripted service).
88 A _bgprocess_ service is a mix between a process service and a scripted
89 service. A command is used to start the service, and once started, the
90 process ID is expected to be available in a file which Dinit can then
91 read. Many existing daemons can operate in this way. The process can only be
92 supervised if Dinit runs as the system "init" (PID 1), or can otherwise mark
93 itself as a subreaper (which is possible on Linux, FreeBSD and DragonFlyBSD) -
94 otherwise Dinit can not reliably know when the process has terminated.
96 (Note, use of bgprocess services type requires care. The file from which the
97 PID is read is trusted; Dinit may send signals to the specified PID. It
98 should not be possible for unauthorised users to modify the file contents!)
100 An _internal_ service is just a placeholder service that can be used to
101 describe a set of dependencies. An internal service has no corresponding
105 ### Service description files
107 Dinit discovers services by reading _service description files_. These files
108 reside in a directory (/etc/dinit.d is the default "system" location, with
109 "/usr/local/lib/dinit.d" and "/lib/dinit.d" also searched) and their name
110 matches the name of the service. Service descriptions are loaded lazily, as
113 (An example of a complete set of system service descriptions can be found in
114 the [doc/linux/services](doc/linux/services) directory).
116 A service description file consists of a number of parameter settings.
117 Settings in the SDF are denoted as a parameter name followed by either an
118 equal sign or colon and then the parameter value (all on the same line).
119 Comments begin with a hash mark (#) and extend to the end of the line (they
120 must be separated from setting values by at least one whitespace character).
122 Parameter values are interpreted literally, except that:
123 - whitespace is collapsed to a single space
124 - double quotes can be used around all or part(s) of a parameter to prevent
125 whitespace collapse and interpretation of special characters
126 - backslash can be used to 'escape' the next character, preventing any
127 special meaning from being associated with it. It can be used to include
128 non-collapsing whitespace, double-quote marks, and backslashes in the
131 Some examples of the available parameters are:
133 type = process | bgprocess | scripted | internal
138 smooth-recovery = (boolean)
142 depends-on = (service name)
143 depends-ms = (service name)
144 waits-for = (service name)
146 Descriptions of individual parameters follows:
148 command = (external script or executable, and arguments)
150 For a 'process' service, this is the process to run.
151 For a 'scripted' service, this command is run to start the service.
153 stop-command = (external script or executable, and arguments)
155 For a 'scripted' service, this command is run to stop the service.
159 Specifies which user to run the process(es) for this service as. The group
160 id for the process will also be set to the primary group of the specified
163 restart = yes | true | no | false
165 Specifies whether the service should automatically restart if it becomes
166 stopped (for any reason, including being explicitly requested to stop).
167 Only active services will restart automatically.
169 smooth-recovery = yes | true | no | false
171 For process services only. Specifies that, should the process die, it
172 can be restarted without bringing the service itself down. This means that
173 any dependent services do not need to be stopped/restarted. Such recovery
174 happens regardless of the "restart" setting (if smooth-recovery is enabled,
175 the service does not reach the stopped state when the process terminates
178 logfile = (log file path)
180 Specifies the log file for the service. Output from the service process
183 pid-file = (path to file)
185 For "bgprocess" type services only; specifies the path of the file where
186 daemon will write its process ID before detaching.
188 depends-on = (service name)
190 This service depends on the named service. Starting this service will
191 start the named service; the command to start this service will not be
192 executed until the named service has started. If the named service is
193 stopped then this service will also be stopped.
195 depends-ms = (service name)
197 Indicates a "milestone dependency" on the named service. This service
198 requires the named service to start before it starts itself. Once the
199 named service has started, it remains active due to the dependency, but if
200 it stops for any reason then the dependency link is broken until the next
201 time this service is started.
203 waits-for = (service name)
205 When this service is started, wait for the named service to finish
206 starting (or to fail starting) before commencing the start procedure
207 for this service. Starting this service will automatically start
210 options = ( runs-on-console | nosigterm | starts-rwfs | starts-log ) ...
212 Specifies various options for this service:
214 `no-sigterm` : specifies that the TERM signal should not be send to the
215 process to terminate it. (Another signal can be specified using
216 the "termsignal" setting; if no other signal is specified, NO
217 signal will be sent).
219 `runs-on-console` : specifies that this service uses the console; its input
220 and output should be directed to the console. A service running
221 on the console prevents other services from running on the
222 console (they will queue for the console).
223 The "interrupt" key (normally control-C) will be active for
224 process / scripted services that run on the console. Handling
225 of an interrupt is determined by the service process, but
226 typically will cause it to terminate.
228 `starts-on-console` : specifies that this service uses the console during
229 service startup. This is implied by runs-on-console, but can
230 be specified separately for services that need the console
231 while they start but not afterwards.
232 This setting is not applicable to regular "process" services,
233 but can be used for "scripted" and "bgprocess" services. It
234 allows for interrupting startup via the "interrupt" key
235 (normally control-C). This is useful to allow filesystem checks
236 to be interrupted/skipped.
238 `start-interruptible` : this service can have its startup interrupted
239 (cancelled) if it becomes inactive while still starting.
240 The SIGINT signal will be sent to the signal to cancel its
241 startup. This is meaningful only for scripted and bgprocess
244 Please see the manual page for a full list of service parameters and options.
247 ## Controlling services
249 ### Service hierarchy and states
251 Services can depend on other services for operation, and so form a
252 dependency hierarchy. Starting a service which depends on another
253 causes that other service to start (and the first service waits until
254 the latter has started before its process is launched and it is itself
257 Services are considered _active_ when they are not stopped. Services
258 can also be explicitly marked as active (this normally happens when you
259 explicitly start a service). Finally, a service with an active dependent
260 is also considered active.
262 If a service stops and becomes inactive (i.e. it is not explicitly marked
263 active and has no active dependents) then any services it depends on will
264 also be marked inactive and stopped unless they have other active
265 dependents, or were explicitly started and marked active.
267 What this means is that, in general, starting an (inactive, stopped)
268 service and then stopping it will return the system to its prior state -
269 no dependencies which were started automatically will be left running.
273 You can use the "dinitctl" utility to start and stop services. Typical invocations
276 dinitctl start <service-name>
277 dinitctl stop <service-name>
278 dinitctl release <service-name>
280 Note that a "start" markes the service active, as well as starting it if it is
281 not already started; the opposite of this is actually "release", which clears
282 the active mark and stops it if it has no active dependent services. The "stop"
283 command by default acts as a "release" which also forces the service to stop
284 (although it may then immediately restart, depending on how it and its
285 dependents are configured).
287 Use the "-s" switch to talk the "system" instance of Dinit, rather than a
288 personal instance, e.g:
290 dinitctl -s start mysql # start system mysql service
292 For complete details on the command line, use:
296 You can "pin" a service in either the stopped or started state, which prevents
297 it from changing state either due to a dependency/dependent or a direct
300 dinitctl -s start --pin mysql # start mysql service, pin it as "started"
301 dinitctl -s stop mysql # issues stop, but doesn't take effect due to pin
302 dinitctl -s unpin mysql # release pin; service will now stop
304 You can pin a service in the stopped state in order to make sure it doesn't
305 get started accidentally (either via a dependency or directly). You can also
306 use it to temporarily keep stopped a service that would otherwise restart
307 immediately when you stopped it (because it, or a dependent, is configured
308 to restart automatically).
310 Finally, you can list the state of all loaded services:
314 This may result in something like the following:
317 [{+} ] tty1 (pid: 300)
318 [{+} ] tty2 (pid: 301)
319 [{+} ] tty3 (pid: 302)
320 [{+} ] tty4 (pid: 303)
321 [{+} ] loginready (has console)
324 [{+} ] udevd (pid: 4)
327 The above represents a number of started services and one stopped service
328 (mysql). Services transitioning state (starting or stopping) are displayed
329 with an arrow indicating the transition direction:
331 [{ }<< ] mysql # starting
332 [ >>{ }] mysql # stopping
334 The curly brackets indicate the desired state, which may not be the state to
335 which the service is currently transitioning. For example:
337 [ <<{ }] mysql # starting, but will stop after starting
338 [{ }>> ] mysql # stopping, but will restart once stopped
340 Remember that a "starting" service may be waiting for its dependencies to
341 start, and a "stopping" service may be waiting for its dependencies to stop.