Writing Init Scripts - Revision history

Prabuanand: removed draft notice, cleaned up introduction, moved headings, added wikitags

2025-09-19T07:41:30Z

removed draft notice, cleaned up introduction, moved headings, added wikitags

2025-09-12T22:00:09Z

Add missing docs for start, stop, restart, and Daemon, Forking, Logging

@@ Line 109: / Line 109: @@
 === stop ===
 === restart ===
 == Daemon, Forking, Logging ==
-TODO...
+If your daemon supports running in the foreground, set <code>command_background="yes"</code> and add a <code>--no-fork</code> or <code>--foreground</code> option to <code>command_args</code>. This prevents the daemon from forking itself into the background, so OpenRC can handle backgrounding.
 [[Category:Booting]]

2025-09-05T12:52:41Z

Things to avoid: this advice runs contrary to upstream advise, and users can still disable this by using 'unset' in conf.d

← Older revision		Revision as of 12:52, 5 September 2025
Line 17:		Line 17:

	== Things to avoid ==		== Things to avoid ==

	* Do '''not''' define <code>supervisor=supervise-daemon</code> in init.d script! This way the user cannot disable it without modifying the init.d script. If you really want to predefine ''supervise-daemon'' for particular service, define it in the corresponding conf.d file.

	* Prefer standard OpenRC variables such as <code>command_args</code>, <code>command_user</code> etc. (see [https://www.mankier.com/8/openrc-run openrc-run(8)]); do not create unnecessary config variables like <code>FOO_OPTS</code>, <code>FOO_USER</code> etc. If you want to predefine the default value in init.d script, use common idiom <code>: ${command_user=foo}</code>.		* Prefer standard OpenRC variables such as <code>command_args</code>, <code>command_user</code> etc. (see [https://www.mankier.com/8/openrc-run openrc-run(8)]); do not create unnecessary config variables like <code>FOO_OPTS</code>, <code>FOO_USER</code> etc. If you want to predefine the default value in init.d script, use common idiom <code>: ${command_user=foo}</code>.

2023-08-25T21:20:50Z

use https

← Older revision		Revision as of 21:20, 25 August 2023
Line 9:		Line 9:
	If you cannot find an init.d script from Gentoo, or you just want to start to write your own init.d scripts, we provide you with some basic information on how to write simple OpenRC init scripts.		If you cannot find an init.d script from Gentoo, or you just want to start to write your own init.d scripts, we provide you with some basic information on how to write simple OpenRC init scripts.

	Primary information about the OpenRC format can be found in the [~~http~~://manpages.org/openrc-run/8 OpenRC man page openrc-run].		Primary information about the OpenRC format can be found in the [https://manpages.org/openrc-run/8 OpenRC man page openrc-run].

	<pre>		<pre>

2023-08-05T11:51:34Z

Services supervised by s6: upgrade hyperlink to https

← Older revision		Revision as of 11:51, 5 August 2023
Line 38:		Line 38:
	</pre>		</pre>

	=== Services supervised by [~~http~~://www.skarnet.org/software/s6/ s6] ===		=== Services supervised by [https://www.skarnet.org/software/s6/ s6] ===

	Notes:		Notes:

2022-04-10T01:36:30Z

Things to avoid

← Older revision		Revision as of 01:36, 10 April 2022
Line 19:		Line 19:

	* Do '''not''' define <code>supervisor=supervise-daemon</code> in init.d script! This way the user cannot disable it without modifying the init.d script. If you really want to predefine ''supervise-daemon'' for particular service, define it in the corresponding conf.d file.		* Do '''not''' define <code>supervisor=supervise-daemon</code> in init.d script! This way the user cannot disable it without modifying the init.d script. If you really want to predefine ''supervise-daemon'' for particular service, define it in the corresponding conf.d file.

			* Prefer standard OpenRC variables such as <code>command_args</code>, <code>command_user</code> etc. (see [https://www.mankier.com/8/openrc-run openrc-run(8)]); do not create unnecessary config variables like <code>FOO_OPTS</code>, <code>FOO_USER</code> etc. If you want to predefine the default value in init.d script, use common idiom <code>: ${command_user=foo}</code>.

			* Use snake_case for naming extra configuration variables (to be consistent with the OpenRC variables and other init scripts in Alpine). Do not prefix them with the service name, try to be consistent with existing init scripts (e.g. <code>cfgfile</code>, <code>cfgdir</code>, <code>logfile</code>, <code>cachedir</code>, <code>listen_on</code>, <code>start_wait</code>, …).

	== Minimal Templates ==		== Minimal Templates ==

2022-04-10T01:19:52Z

Add section Things to avoid

← Older revision		Revision as of 01:19, 10 April 2022
Line 15:		Line 15:
	man openrc-run		man openrc-run
	</pre>		</pre>

			== Things to avoid ==

			* Do '''not''' define <code>supervisor=supervise-daemon</code> in init.d script! This way the user cannot disable it without modifying the init.d script. If you really want to predefine ''supervise-daemon'' for particular service, define it in the corresponding conf.d file.

	== Minimal Templates ==		== Minimal Templates ==

2020-02-05T09:32:50Z

Introduction

← Older revision		Revision as of 09:32, 5 February 2020
Line 11:		Line 11:
	Primary information about the OpenRC format can be found in the [http://manpages.org/openrc-run/8 OpenRC man page openrc-run].		Primary information about the OpenRC format can be found in the [http://manpages.org/openrc-run/8 OpenRC man page openrc-run].

	<~~code~~>apk add openrc-doc ~~man</code>~~		<pre>
			apk add openrc-doc
	~~<code>~~man openrc-run</~~code~~>		man openrc-run
			</pre>

	== Minimal Templates ==		== Minimal Templates ==

2020-02-05T09:32:11Z

Services relying on OpenRC exclusively

2019-01-24T11:40:00Z

Reverted edits by Lchristolo (talk) to last revision by OxR463

← Older revision		Revision as of 11:40, 24 January 2019
Line 102:		Line 102:

	=== stop ===		=== stop ===

	~~<pre>~~
	~~stop() {~~
	~~ebegin "Stopping mydaemon"~~
	~~start-stop-daemon --stop --exec /home/user/mydaemon\~~
	~~--pidfile /home/user/mydaemon.pid~~
	~~eend $?~~
	}
	~~</pre>~~

	=== restart ===		=== restart ===