Running Jupyter/JupyterHub/JupyterLab as a system service

Jupyter/JupyterHub/JupyterLab can run in many ways, including command line, system service, Docker instance, Kubernetes application, etc. Here is how to run it as a system service by using the< magic operator of IPython 6/Jupyter>,<Magic operators of IPython >Can provide better console operation (who uses who knows! If you need to enter a password in the Notebook, you can use the sshpass reference< Secure interaction with SSH pass remote script on Ubuntu>  ), also supports the standard remote shell console.

First, install Anaconda, Jupyter, and jupyterab on the host computer. The method is as follows:

1,Jupyter for Ubuntu/Debian Anaconda3 with systemd

To create a service description file:


Edit file:

sudo nano /etc/systemd/system/jupyter.service

Copy in the following:


ExecStart=/home/supermap/anaconda3/bin/jupyter lab --ip=



Reload service:

sudo systemctl daemon-reload

Start service:

sudo systemctl start jupyter

View status:

sudo systemctl status jupyter --no-pager

You can see the corresponding login address, token and other information, which can be accessed by entering it into the browser.

Set to auto start on system start:

sudo systemctl enable jupyter

2,JupyterHub for Ubuntu/Debian Anaconda3 with systemd

If you use JupyterHub, use / opt/anaconda3/jupyterhub as the configuration directory. Save the following as the file / etc/systemd/system/jupyterhub.service.


ExecStart=/opt/anaconda3/bin/jupyterhub -f /etc/jupyterhub/


If c.jupyterhub.cleanup'servers = false is saved in JupyterHub config, KillMode=process needs to be added in the [Service] section. By default, systemd will kill all child processes on exit.

Use sudo systemctl daemon reload and sudo systemctl < start| stop| status > jupyterhub to start the service. sudo systemctl enable jupyterhub will enable the jupyterhub to start automatically.

3. Non systemd configuration of JupyterHub for Ubuntu/Debian

Preservation Is / etc/init.d/jupyterhub. As follows:

#! /bin/sh
# Provides:          jupyterhub
# Required-Start:    $remote_fs $syslog
# Required-Stop:     $remote_fs $syslog
# Default-Start:     2 3 4 5
# Default-Stop:      0 1 6
# Short-Description: Start jupyterhub
# Description:       This file should be used to construct scripts to be
#                    placed in /etc/init.d.

# Author: Alisue <>
# Please remove the "Author" lines above and replace them
# with your own name if you copy and modify this script.

# Do NOT "set -e"

# PATH should only include /usr/* if it runs after the script
DESC="Multi-user server for Jupyter notebooks"

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

# 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
	# Return
	#   0 if daemon has been started
	#   1 if daemon was already running
	#   2 if daemon could not be started
	start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
		|| return 1
	start-stop-daemon --start --background --make-pidfile --quiet --pidfile $PIDFILE --exec $DAEMON -- \
		|| return 2
	# Add code here, if necessary, that waits for the process to be ready
	# to handle requests from services started subsequently which depend
	# on this one.  As a last resort, sleep for some time.

# Function that stops the daemon/service
	# 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
	[ "$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
	[ "$?" = 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() {
	# If the daemon can reload its configuration without
	# restarting (for example, when it is sent a SIGHUP),
	# then implement that here.
	start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
	return 0

case "$1" in
	[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
	case "$?" in
		0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
		2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
	[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
	case "$?" in
		0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
		2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
	status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $?
	# If do_reload() is not implemented then leave this commented out
	# and leave 'force-reload' as an alias for 'restart'.
	#log_daemon_msg "Reloading $DESC" "$NAME"
	#log_end_msg $?
	# If the "reload" option is implemented then remove the
	# 'force-reload' alias
	log_daemon_msg "Restarting $DESC" "$NAME"
	case "$?" in
		case "$?" in
			0) log_end_msg 0 ;;
			1) log_end_msg 1 ;; # Old process is still running
			*) log_end_msg 1 ;; # Failed to start
		# Failed to stop
		log_end_msg 1
	#echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
	echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
	exit 3


Then, perform the configuration process:

$ sudo chmod +x /etc/init.d/jupyterhub
# Create a default config to /etc/jupyterhub/
$ sudo jupyterhub --generate-config -f /etc/jupyterhub/
# Reload systemctl daemon to notice the init.d script
$ sudo systemctl daemon-reload
# Start jupyterhub
$ sudo service jupyterhub start
# Stop jupyterhub
$ sudo service jupyterhub stop
# Start jupyterhub on boot
$ sudo update-rc.d jupyterhub defaults
# Or use rcconf to manage services
$ sudo rcconf

4,JupyterHub for CentOS/Fedora with Generic systemd

Assuming / etc/jupyterhub is used as configs, save the following to the file / lib/systemd/system/jupyterhub.service:


ExecStart=/usr/bin/jupyterhub --JupyterHub.spawner_class=sudospawner.SudoSpawner

  • Be careful:
    • needs to be added to [Unit] section, otherwise setting service startup will fail because the network is not available yet.
    • Set the correct User and the permissions to run / usr/bin/jupyterhub.

Run: sudo systemctl daemon reload. Then sudo systemctl < start| stop| status > jupyterhub to start the service.

  • Be careful:
    • Make sure to install sudospawner.SudoSpawner and run pip3 install git+

5,JupyterHub for OSX

Add jupyterhub ﹐ to / etc/jupyterhub (if not, create it). Create / Library/LaunchDaemons/com.jupyterhub.plist paste the following and edit the path to point to jupyterhub.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "">
<plist version="1.0">


Load and start the service as follows:

sudo launchctl load -w /Library/LaunchDaemons/com.jupyterhub.plist
sudo launchctl start -w /Library/LaunchDaemons/com.jupyterhub.plist

Your jupyterhub can be accessed through localhost:8000 (the default config) (if external machine access is required, add the -- ip=x.x.x.x. parameter to the startup command line). If you can't access it, use / var/log/system.log | grep jupyter to view the status or the log file / var/log/jupyterhubout.log to view the reason.

6, others

View And share your experience.

Further reference:

Keywords: Big Data jupyter sudo Ubuntu Kubernetes

Added by pramodv on Wed, 08 Jan 2020 06:01:58 +0200