Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Template file for creating linux services out of executables using the start-stop-daemon
#!/bin/bash
### BEGIN INIT INFO
# Provides: <service name>
# Required-Start: $remote_fs $syslog
# Required-Stop: $remote_fs $syslog
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: <service description>
### END INIT INFO
#################################################################################
#
# start-stop-daemon template for creating service scripts out of executables
#
# Most of the installations can be achived by changing the variables below.
#
# This template is meant to be used freely.
# This template derives from a common template that is found on the web.
# Unfornately I could not find the original source to give the proper credits
#
# source: https://gist.github.com/bcap/5397674
# Feel free to contribute!
#################################################################################
#################################################################################
# Fill/change the following vars
#################################################################################
PATH=/sbin:/usr/sbin:/bin:/usr/bin
DESC="<service description>" # String describing the service
NAME="<service name>" # Name of the service, will be used in another vars
DAEMON="/usr/bin/service-executable" # Path to the service executable, e.g. /usr/bin/java
DAEMON_ARGS="-a -b -some-arg=some-value" # Arguments passed to the service startup
WORK_DIR="/var/lib/${NAME}" # Working directory where the service will be started, defaults to /var/lib/${NAME}
USER=$NAME # User that will spawn the process, defaults to the service name
GROUP=$NAME # Group that will spawn the process, defaults to the service name
PIDFILE=/var/run/${NAME}.pid # Pid file location, defaults to /var/run/${NAME}.pid
SCRIPTNAME=/etc/init.d/$NAME # Location of this init script
LOG_PATH=/var/log/$NAME # Standard output and Standard error will be outputted here
START_STOP_DAEMON_OPTIONS="--chuid=$USER:$GROUP --background --chdir=$WORK_DIR"
#################################################################################
# Change the code below if needed
#################################################################################
# Exit if the package is not installed
[ -x "$DAEMON" ] || exit 0
# Read configuration variable file if it is present
[ -r /etc/default/$NAME ] && . /etc/default/$NAME
# Load the VERBOSE setting and other rcS variables
. /lib/init/vars.sh
# Define LSB log_* functions.
# Depend on lsb-base (>= 3.2-14) to ensure that this file is present
# and status_of_proc is working.
. /lib/lsb/init-functions
#
# Function that starts the daemon/service
#
do_start()
{
# Return
# 0 if daemon has been started
# 1 if daemon was already running
# 2 if daemon could not be started
start-stop-daemon $START_STOP_DAEMON_OPTIONS --start --pidfile $PIDFILE --exec $DAEMON --test >> ${LOG_PATH}/${NAME}.out 2>> ${LOG_PATH}/${NAME}.err || return 1
start-stop-daemon $START_STOP_DAEMON_OPTIONS --start --pidfile $PIDFILE --exec $DAEMON -- $DAEMON_ARGS >> ${LOG_PATH}/${NAME}.out 2>> ${LOG_PATH}/${NAME}.err || return 2
# Add code here, if necessary, that waits for the process to be ready
# to handle requests from services started subsequently which depend
# on this one. As a last resort, sleep for some time.
}
#
# Function that stops the daemon/service
#
do_stop()
{
# Return
# 0 if daemon has been stopped
# 1 if daemon was already stopped
# 2 if daemon could not be stopped
# other if a failure occurred
start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE
RETVAL="$?"
[ "$RETVAL" = 2 ] && return 2
# Wait for children to finish too if this is a daemon that forks
# and if the daemon is only ever run from this initscript.
# If the above conditions are not satisfied then add some other code
# that waits for the process to drop all resources that could be
# needed by services started subsequently. A last resort is to
# sleep for some time.
start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
[ "$?" = 2 ] && return 2
# Many daemons don't delete their pidfiles when they exit.
rm -f $PIDFILE
return "$RETVAL"
}
#
# Function that sends a SIGHUP to the daemon/service
#
do_reload() {
#
# If the daemon can reload its configuration without
# restarting (for example, when it is sent a SIGHUP),
# then implement that here.
#
start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
return 0
}
case "$1" in
start)
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
do_start
case "$?" in
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
esac
;;
stop)
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
do_stop
case "$?" in
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
esac
;;
status)
status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $?
;;
#reload|force-reload)
#
# If do_reload() is not implemented then leave this commented out
# and leave 'force-reload' as an alias for 'restart'.
#
#log_daemon_msg "Reloading $DESC" "$NAME"
#do_reload
#log_end_msg $?
#;;
restart|force-reload)
#
# If the "reload" option is implemented then remove the
# 'force-reload' alias
#
log_daemon_msg "Restarting $DESC" "$NAME"
do_stop
case "$?" in
0|1)
do_start
case "$?" in
0) log_end_msg 0 ;;
1) log_end_msg 1 ;; # Old process is still running
*) log_end_msg 1 ;; # Failed to start
esac
;;
*)
# Failed to stop
log_end_msg 1
;;
esac
;;
*)
#echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
exit 3
;;
esac
:
@lukasmrtvy
Copy link

lukasmrtvy commented Aug 23, 2015

Notice:
LOG_PATH variable should be LOG_PATH=/var/log/
and
USER, GROUP, WORK_DIR should exist

@szepeviktor
Copy link

szepeviktor commented Aug 21, 2016

@bcap Thank you for your script.
I am in the process of enhancing it: https://github.com/szepeviktor/debian-server-tools/blob/master/package/lsb-init-script-executable

All the best!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment