じかんのむだ

読んで時間の無駄にならないようなブログを目指して。

Ubuntu Server 14.10でIRC Bouncer 「ZNC」をデーモン化して使う

 IRC(うちのアイマスコミュニティはLINEやカカオトークなどを入れてる人がほとんどいないのとキーボードの方が打つのが早いのでIRCでチャットしている)で話してると「VPSIRCプロキシ建てるか」ととある男。tiarraでやってました。

 なんか面白そうだったので俺もやってみた。

 情報を集めていると「ZNC」というのがUbuntuリポジトリに入っているらしい。日本語のドキュメントもそこそこあったのでこれに決めた。

 インストールは

$ sudo apt-get install znc

 でおしまい。Daemonで動かさないなら

$ znc --makeconf

 でいろいろ設定をして(プラグインはwebadminくらいしかyesにしなかった)「~/.znc」以下に設定が保存されて自動的にバックグラウンドでの動作になる。再起動するたびにZNCを自分で起動しないといけない($ znc   で起動)けどこれがお気軽。

 しかし、やっぱり不測のVPSメンテナンスに備えDaemon化はしたい。ログが取れないとか常駐ができないダメなIRC Bouncerにはしたくない。ということで以下はDaemon化させるための手順。基本的にRunning ZNC as a system daemonを見ればいいけど英語やだと言う人のために。

$ sudo useradd --system --shell /sbin/nologin --comment "Account to run ZNC daemon" --user-group znc

 としてDaemonを動作させるユーザーを作成する。そして「/var/lib/znc」ディレクトリを作りパーミッションを666あたりにして

$ sudo -u znc /usr/bin/znc --datadir=/var/lib/znc --makeconf

 を起動し、ユーザーzncでコンフィグを作成する。そのまま実行され常駐するがここでいったんZNCを止める。init.dスクリプトは「/etc/init.d/znc」とし、内容は

#! /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

 とし、 保存(これは元サイトからコピペしたほうがいいかも)。そして

$ sudo chmod 755 /etc/init.d/znc

 で、スクリプトに実行権限を与える。最後に

$ sudo update-rc.d znc defaults

 でinit.dで動くように登録する。これでシステム起動時に自動でZNCが起動され、チャンネルに常駐するように設定していれば常駐するようになる。

$ sudo service znc start

 でDaemonとして起動するし、stopで止まるしreloadでコンフィグ読み直すしrestartで再起動する。あとはstatusで状態を見ることができる。

 スクリプトが長いだけでやることは少ないです。IRCスマホからもできるしiTunesカード買ってくれって言われることもないし、便利ですよ。