From 78972b1d4014ec91246495e7ecd50174f506e928 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Mon, 16 Sep 2013 18:09:39 +0200 Subject: [PATCH] New init script that also evaluates "/etc/default/octoprint" for additional startup options and the like, courtesy of Sami Olmari --- scripts/octoprint.default | 19 +++++ scripts/octoprint.init | 142 +++++++++++++++++++++++++++++++------- 2 files changed, 136 insertions(+), 25 deletions(-) create mode 100644 scripts/octoprint.default diff --git a/scripts/octoprint.default b/scripts/octoprint.default new file mode 100644 index 00000000..0dba7831 --- /dev/null +++ b/scripts/octoprint.default @@ -0,0 +1,19 @@ +# Configuration for /etc/init.d/octoprint + +# The init.d script will only run if this variable non-empty. +OCTOPRINT_USER=pi + +# On what port to run daemon, default is 5000 +PORT=5000 + +# Path to the OctoPrint executable, use this to override the default setting "/usr/bin/octoprint" +#DAEMON=/path/to/octoprint/executable + +# What arguments to pass to octoprint, usually no need to touch this +DAEMON_ARGS="--port=$PORT" + +# Umask of files octoprint generates, Change this to 000 if running octoprint as its own, separate user +UMASK=022 + +# Should we run at startup? +START=yes diff --git a/scripts/octoprint.init b/scripts/octoprint.init index ad0a983c..87bf9875 100644 --- a/scripts/octoprint.init +++ b/scripts/octoprint.init @@ -1,49 +1,141 @@ #!/bin/sh -# -# Copy this script to /etc/init.d/octoprint and adjust the variables -# at the top to match your installation (should be okay for a Raspian -# setup). Then link it to the correct run levels. On Debian/Rasbian -# just call 'sudo update-rc.d octoprint defaults' ### BEGIN INIT INFO # Provides: octoprint # Required-Start: $local_fs networking # Required-Stop: # Should-Start: +# Should-Stop: # Default-Start: 2 3 4 5 # Default-Stop: 0 1 6 -# Short-Description: Run octoprint -# Description: Octoprint provides a responsive web interface for -# controlling a 3D printer +# Short-Description: OctoPrint daemon +# Description: Starts the OctoPrint daemon with the user specified in +# /etc/default/octoprint. ### END INIT INFO +# Author: Sami Olmari -# OctoPrint's run script -DAEMON=/home/pi/OctoPrint/run +PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin +DESC="Octoprint Daemon" +NAME="Octoprint" +DAEMON=/usr/bin/octoprint +PIDFILE=/var/run/$NAME.pid +PKGNAME=octoprint +SCRIPTNAME=/etc/init.d/$PKGNAME -# Port to use -PORT=5000 +# Read configuration variable file if it is present +[ -r /etc/default/$PKGNAME ] && . /etc/default/$PKGNAME -# Run as this user -RUNAS=pi - -# Exit if the run script is not found +# Exit if the octoprint is not installed [ -x "$DAEMON" ] || exit 0 +# Load the VERBOSE setting and other rcS variables +[ -f /etc/default/rcS ] && . /etc/default/rcS + +# Define LSB log_* functions. +# Depend on lsb-base (>= 3.0-6) to ensure that this file is present. +. /lib/lsb/init-functions + +if [ -z "$START" -o "$START" != "yes" ] +then + log_warning_msg "Not starting $PKGNAME, edit /etc/default/$PKGNAME to start it." + exit 0 +fi + +if [ -z "$OCTOPRINT_USER" ] +then + log_warning_msg "Not starting $PKGNAME, OCTOPRINT_USER not set in /etc/default/$PKGNAME." + exit 0 +fi + +# +# Function to verify if a pid is alive +# +is_alive() +{ + pid=`cat $1` > /dev/null 2>&1 + kill -0 $pid > /dev/null 2>&1 + return $? +} + +# +# 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 + + is_alive $PIDFILE + RETVAL="$?" + + if [ $RETVAL != 0 ]; then + start-stop-daemon --start --background --quiet --pidfile $PIDFILE --make-pidfile \ + --exec $DAEMON --chuid $OCTOPRINT_USER --user $OCTOPRINT_USER --umask $UMASK -- $DAEMON_ARGS + RETVAL="$?" + fi +} + +# +# 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 --user $OCTOPRINT_USER --pidfile $PIDFILE + RETVAL="$?" + [ "$RETVAL" = "2" ] && return 2 + + rm -f $PIDFILE + + [ "$RETVAL" = "0" ] && return 0 || return 1 +} case "$1" in start) - su $RUNAS -c "$DAEMON --port=$PORT --daemon 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) - su $RUNAS -c "$DAEMON --port=$PORT --daemon 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 + ;; restart) - su $RUNAS -c "$DAEMON --port=$PORT --daemon restart" - ;; + 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: $0 {start|stop|restart}" >&2 - ;; + echo "Usage: $SCRIPTNAME {start|stop|restart}" >&2 + exit 3 + ;; esac -: