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
(su -c does not run znc --makeconf interactively)
m (Created an introduction.)
Line 1: Line 1:
 
'''Note: if you just want to run ZNC automatically, when server is turned on, look [[FAQ#How_can_I_restart_ZNC_automatically_.28in_case_of_a_machine_reboot.2C_crash.2C_etc..29.3F|here]] instead.
 
'''Note: if you just want to run ZNC automatically, when server is turned on, look [[FAQ#How_can_I_restart_ZNC_automatically_.28in_case_of_a_machine_reboot.2C_crash.2C_etc..29.3F|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.
  
Instructions for Debian.
+
* Create a new system user:
 
 
If you want to run ZNC as a system service you need to (the following commands are to be executed as root):
 
* create a new system user:
 
 
  adduser --system --home /var/lib/znc --group znc
 
  adduser --system --home /var/lib/znc --group znc
* 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
Line 148: Line 146:
 
   
 
   
 
  :
 
  :
# 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
# execute:
+
# Execute:
 
  update-rc.d znc defaults
 
  update-rc.d znc defaults
* configure ZNC:
+
* Configure ZNC:
 
  sudo -u znc /usr/bin/znc --datadir=/var/lib/znc --makeconf
 
  sudo -u znc /usr/bin/znc --datadir=/var/lib/znc --makeconf
* add the line
+
* Add the line
 
  PidFile = /var/run/znc/znc.pid
 
  PidFile = /var/run/znc/znc.pid
 
to the global section of the configuration file <code>/var/lib/znc/configs/znc.conf</code>
 
to the global section of the configuration file <code>/var/lib/znc/configs/znc.conf</code>
* start the service:
+
* Start the service:
 
  service znc start
 
  service znc start
* verify that the service is running:
+
* Verify that the service is running:
 
  service znc status
 
  service znc status

Revision as of 06:40, 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:
adduser --system --home /var/lib/znc --group znc
  • Install an init file:
  1. create a file /etc/init.d/znc with the following content:
#! /bin/sh
### BEGIN INIT INFO
# Provides:          znc
# Required-Start:    $remote_fs $syslog
# Required-Stop:     $remote_fs $syslog
# Default-Start:     2 3 4 5
# Default-Stop:      0 1 6
# Short-Description: ZNC IRC bouncer
# Description:       ZNC is an IRC bouncer
### END INIT INFO
 
PATH=/sbin:/usr/sbin:/bin:/usr/bin
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
[ -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
	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
}

#
# 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 --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"
}

#
# Function that sends a SIGHUP to the daemon/service
#
do_reload() {
	start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME --chuid $USER
	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 -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
		;;
	  *)
		# Failed to stop
		log_end_msg 1
		;;
	esac
	;;
  *)
	echo "Usage: $SCRIPTNAME {status|start|stop|reload|restart}" >&2
	exit 3
	;;
esac

:
  1. Give the right permissions to this file:
chmod 755 /etc/init.d/znc
  1. Execute:
update-rc.d znc defaults
  • Configure ZNC:
sudo -u znc /usr/bin/znc --datadir=/var/lib/znc --makeconf
  • Add the line
PidFile = /var/run/znc/znc.pid

to the global section of the configuration file /var/lib/znc/configs/znc.conf

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