To create new wiki account, please join us on #znc at freenode and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.

Difference between revisions of "Running ZNC as a system daemon"

From ZNC
Jump to: navigation, search
(Simplified and tried to clarify `adduser`.)
(Switched the init.d script to be the one from CentOS (cross platform instead of Debian specific).)
Line 9: Line 9:
 
* Install an init file:
 
* Install an init file:
 
# create a file <code>/etc/init.d/znc</code> with the following content:
 
# create a file <code>/etc/init.d/znc</code> with the following content:
  #! /bin/sh
+
  #!/bin/sh
  ### BEGIN INIT INFO
+
  #
  # Provides:          znc
+
  # znc - Advanced IRC Bouncer INIT script for Fedora #
# Required-Start:    $remote_fs $syslog
+
  # chkconfig: 35 99 14
# Required-Stop:    $remote_fs $syslog
+
  # description: An Advanced IRC bouncer INIT script for
  # Default-Start:     2 3 4 5
+
  # Source function library.
  # Default-Stop:     0 1 6
+
  . /etc/rc.d/init.d/functions
# Short-Description: ZNC IRC bouncer
+
   
  # Description:      ZNC is an IRC bouncer
+
  exec=/usr/bin/znc
  ### END INIT INFO
+
  prog=znc
 
+
  config=/var/lib/znc
PATH=/sbin:/usr/sbin:/bin:/usr/bin
+
  runas=znc
  DESC="ZNC daemon"
 
NAME=znc
 
  DAEMON=/usr/bin/$NAME
 
  DATADIR=/var/lib/znc
 
  DAEMON_ARGS="--datadir=$DATADIR"
 
PIDDIR=/var/run/znc
 
  PIDFILE=$PIDDIR/$NAME.pid
 
SCRIPTNAME=/etc/init.d/$NAME
 
USER=znc
 
GROUP=znc
 
 
   
 
   
  # Exit if the package is not installed
+
  lockfile=/var/lock/subsys/$prog
[ -x "$DAEMON" ] || exit 0
 
 
   
 
   
  # Read configuration variable file if it is present
+
  start() {
[ -r /etc/default/$NAME ] && . /etc/default/$NAME
+
[ -x $exec ] || exit 5
 +
echo -n $"Starting $prog: "
 +
# if not running, start it up here, usually something like "daemon $exec"
 +
daemon --user $runas "$exec -d $config >/dev/null 2>&1"
 +
# If you're reckless with your system, comment the line above and
 +
# uncomment this one below... I just don't get it why
 +
# daemon "$exec -r -d $config >/dev/null 2>&1"
 +
retval=$?
 +
echo
 +
[ $retval -eq 0 ] && touch $lockfile
 +
return $retval
 +
}
 
   
 
   
  # Load the VERBOSE setting and other rcS variables
+
  stop() {
  . /lib/init/vars.sh
+
echo -n $"Stopping $prog: "
 +
# stop it here, often "killproc $prog"
 +
killproc $prog -TERM
 +
retval=$?
 +
echo
 +
[ $retval -eq 0 ] && rm -f $lockfile
 +
return $retval
 +
  }
 
   
 
   
  # Define LSB log_* functions.
+
  reload() {
# Depend on lsb-base (>= 3.2-14) to ensure that this file is present
+
echo -n $"Reloading $prog: "
# and status_of_proc is working.
+
# stop it here, often "killproc $prog"
  . /lib/lsb/init-functions
+
killproc $prog -HUP
 +
retval=$?
 +
echo
 +
  }
 
   
 
   
  #
+
  restart() {
# Function that starts the daemon/service
+
  stop
#
+
  start
do_start()
 
{
 
  # Return
 
#  0 if daemon has been started
 
#  1 if daemon was already running
 
#  2 if daemon could not be started
 
if [ ! -d $PIDDIR ]
 
then
 
mkdir $PIDDIR
 
fi
 
chown $USER:$GROUP $PIDDIR
 
start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test --chuid $USER > /dev/null || return 1
 
  start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --chuid $USER -- $DAEMON_ARGS > /dev/null || return 2
 
 
  }
 
  }
 
   
 
   
  #
+
  rh_status() {
# Function that stops the daemon/service
+
  # run checks to determine if the service is running or use generic status
#
+
  status $prog
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 --name $NAME --chuid $USER
 
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 --chuid $USER
 
[ "$?" = 2 ] && return 2
 
# Many daemons don't delete their pidfiles when they exit.
 
rm -f $PIDFILE
 
  return "$RETVAL"
 
 
  }
 
  }
 
   
 
   
  #
+
  rh_status_q() {
# Function that sends a SIGHUP to the daemon/service
+
  rh_status >/dev/null 2>&1
#
 
do_reload() {
 
  start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME --chuid $USER
 
return 0
 
 
  }
 
  }
 
   
 
   
 
  case "$1" in
 
  case "$1" in
  start)
+
start)
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
+
  rh_status_q && exit 0
do_start
+
  $1
case "$?" in
+
;;
  0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+
  stop)
  2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+
  rh_status_q || exit 0
  esac
+
  $1
;;
+
;;
  stop)
+
  restart)
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
+
$1
do_stop
+
;;
case "$?" in
+
  reload)
  0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+
  rh_status_q || exit 7
  2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+
  $1
esac
+
;;
;;
+
status)
  status)
+
  rh_status
  status_of_proc -p $PIDFILE "$DAEMON" "$NAME" && exit 0 || exit $?
 
;;
 
  reload)
 
log_daemon_msg "Reloading $DESC" "$NAME"
 
do_reload
 
log_end_msg $?
 
;;
 
  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
 
 
  ;;
 
  ;;
  *)
+
condrestart|try-restart)
  # Failed to stop
+
  rh_status_q || exit 0
  log_end_msg 1
+
  restart
 
  ;;
 
  ;;
  esac
+
  *)
;;
+
echo $"Usage: $0 {start|stop|status|reload|restart|condrestart|try-restart}"
  *)
+
exit 2
echo "Usage: $SCRIPTNAME {status|start|stop|reload|restart}" >&2
 
exit 3
 
;;
 
 
  esac
 
  esac
   
+
  exit $?
:
+
 
 
# Give the right permissions to this file:
 
# Give the right permissions to this file:
 
  chmod 755 /etc/init.d/znc
 
  chmod 755 /etc/init.d/znc

Revision as of 16:18, 2 July 2014

Note: if you just want to run ZNC automatically, when server is turned on, look here instead.

To have ZNC run at boot time as a system daemon we will create a user and group to run ZNC from a configuration we created and then called at each time the system boots. All the commands are expected to run as an administrator.

  • Create a new system user with accompanying group and a shell that cannot be used to login with:
sudo adduser --system --shell /sbin/nologin --comment "Account to run ZNC daemon" --user-group znc
  • Make the configuration we will run at startup:
sudo -u znc /usr/bin/znc --datadir=/var/lib/znc --makeconf
  • Install an init file:
  1. create a file /etc/init.d/znc with the following content:
#!/bin/sh
#
# znc - Advanced IRC Bouncer INIT script for Fedora #
# chkconfig: 35 99 14
# description: An Advanced IRC bouncer INIT script for
# Source function library.
. /etc/rc.d/init.d/functions

exec=/usr/bin/znc
prog=znc
config=/var/lib/znc
runas=znc

lockfile=/var/lock/subsys/$prog

start() {
	[ -x $exec ] || exit 5
	echo -n $"Starting $prog: "
	# if not running, start it up here, usually something like "daemon $exec"
	daemon --user $runas "$exec -d $config >/dev/null 2>&1"
	# If you're reckless with your system, comment the line above and
	# uncomment this one below... I just don't get it why
	# daemon "$exec -r -d $config >/dev/null 2>&1"
	retval=$?
	echo
	[ $retval -eq 0 ] && touch $lockfile
	return $retval
}

stop() {
	echo -n $"Stopping $prog: "
	# stop it here, often "killproc $prog"
	killproc $prog -TERM
	retval=$?
	echo
	[ $retval -eq 0 ] && rm -f $lockfile
	return $retval
}

reload() {
	echo -n $"Reloading $prog: "
	# stop it here, often "killproc $prog"
	killproc $prog -HUP
	retval=$?
	echo
}

restart() {
	stop
	start
}

rh_status() {
	# run checks to determine if the service is running or use generic status
	status $prog
}

rh_status_q() {
	rh_status >/dev/null 2>&1
}

case "$1" in
	start)
		rh_status_q && exit 0
		$1
		;;
	stop)
		rh_status_q || exit 0
		$1
		;;
	restart)
		$1
		;;
	reload)
		rh_status_q || exit 7
		$1
		;;
	status)
		rh_status
		;;
	condrestart|try-restart)
		rh_status_q || exit 0
		restart
		;;
	*)
		echo $"Usage: $0 {start|stop|status|reload|restart|condrestart|try-restart}"
		exit 2
esac
exit $?
  1. Give the right permissions to this file:
chmod 755 /etc/init.d/znc
  1. Execute:
update-rc.d znc defaults


Now that all the pieces are in place you can now start the service yourself or restart the computer for the daemon to take its place.

  • Start the service:
service znc start
  • Verify that the service is running:
service znc status