Debian init script for virtualenv'd gunicorn_django

I recently moved my projects from wsgi to gunicorn and needed init scripts. Here's what I'm currently using.

I have the gunicorns running behind nginx, so you might want to tweak the IP and PORT settings.

It might also be nice to use start-stop-daemon.

#! /bin/sh
### BEGIN INIT INFO
# Provides:          gunicorn-initscript
# Required-Start:    $remote_fs $syslog
# Required-Stop:     $remote_fs $syslog
# Should-Start:      $nginx
# Default-Start:     30 2 3 4 5
# Default-Stop:      70 0 1 6
# Short-Description: virtualenv + gunicorn + nginx debian init script
# Description:       virtualenv + gunicorn + nginx debian init script
### END INIT INFO

# Author: Nicolas Kuttler <hidden>
#
# Please remove the "Author" lines above and replace them
# with your own name if you copy and modify this script.
#
# Enable with update-rc.d gunicorn-example start 30 2 3 4 5 . stop 70 0 1 6 .
# (parameters might not be necessary, test)

# Do NOT "set -e"

PROJECT=/path/to/project/
VIRTUALENV=/path/to/virtualenv
PORT=8888
LOGDIR=/var/log/gunicorn/
# PATH should only include /usr/* if it runs after the mountnfs.sh script
PATH=/bin:/usr/bin
USER=www-data
GROUP=www-data
IP=127.0.0.1
WORKERS=5
# I am lazy and just call the init script gunicorn-project
NAME=`basename $0`
DESC=$NAME
LOGFILE="$LOGDIR$NAME.log"
PIDFILE="$PROJECT$NAME.pid"
CMD="gunicorn_django --user=$USER --group=$GROUP --daemon --workers=$WORKERS --bind=$IP:$PORT --pid=$PIDFILE --name=$NAME --log-file=$LOGFILE --log-level=info"

# 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 [ -e $PIDFILE ]; then
    return 1
  fi
  cd $PROJECT
  . $VIRTUALENV/bin/activate
  $CMD
  if [ $? = 0 ]; then
    return 0
  else
    return 2
  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
  if [ -f $PIDFILE ]; then
    PID=`cat $PIDFILE`
    rm $PIDFILE
    kill -15 $PID
    if [ $? = 0 ]; then
      return 0
    else
      return 2
    fi
  else
    return 1
  fi
}

do_reload() {
  if [ -f $PIDFILE ]; then
    PID=`cat $PIDFILE`
    kill -HUP $PID
    return $?
  fi
  return 2
}

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
  ;;
  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
  ;;
  reload)
  log_daemon_msg "Reloading $DESC" "$NAME"
  do_reload
  case "$?" in
    0) log_end_msg 0 ;;
    *) log_end_msg 1 ;;
  esac
  ;;
  *)
  echo "Usage: $SCRIPTNAME {start|stop|restart|reload}" >&2
  exit 3
  ;;
esac

:

Published on July 15, 2011 at 12:44 p.m. by Nicolas and tagged Django, virtualenv, init, gunicorn, Debian. You can follow the discussion with the comment feed for this post. Feeling generous? Donate!

6 comments

  1. avatar
    wrote this comment on
    Hi, Thanks for this. Very helpful.
    One question: why not put the pidfile in /var/run where are other pid files like nginx?
    Reply to this comment
    1. avatar
      wrote this comment on
      Hi Bernardo, you're right, the file should probably be there. The script was really just a quick hack and there's probably more that's not correct. I put it online because I couldn't find any other and had to write it :-)
      Reply to this comment
  2. avatar
    wrote this comment on
    Hi, thanks for the script. But when I run this from my own user USER, but with www-data user provided with params, python creates files in /tmp/ with USER owning, not www-data. Can you help me. Thank you!
    Reply to this comment
    1. avatar
      wrote this comment on
      You're not supposed to run init scripts as user. I have no idea.
      Reply to this comment
  3. avatar
    wrote this comment on
    Just wanted to say thanks for this script. It's my go-to script for turning virtualenv commands into bootable init.d scripts. I was just fighting with Upstart recently, gave up, and went back to this classic. Classic in the IT world is really two or three years, these days.

    You should share this on github so people can help make it even more epic.
    Reply to this comment
    1. avatar
      wrote this comment on
      Good idea. I should probably polish it first though, it was really just a quick hack.
      Reply to this comment

Start a new thread

Cancel reply
Markdown. Syntax highlighting with <code lang="php"><?php echo "Hello, world!"; ?></code> etc.