Ask Your Question

how to run sage as a service

asked 2011-12-28 03:48:14 -0500

Gong-Yi Liao gravatar image

updated 2015-01-14 02:55:00 -0500

FrédéricC gravatar image

How do I run sage as a web application service (like running an instance of Ruby on Rails or a Django web application) without entering sage ipython CLI session?

Because I don't want to keep a terminal emulator like gnome terminal or x-term open,I just want to run sage in the background with log recorded in some files (say, $HOME/.local/sage/log/notebook.log).

edit retag flag offensive close merge delete

4 answers

Sort by » oldest newest most voted

answered 2011-12-30 03:58:08 -0500

You can put the following command in your $HOME/.profile file.

sage -notebook

This file is executed every time you login.

If you are having multiple simultaneous logins, then you can put some checks whether sage is already running, e.g. using script like

if ps aux | grep 'sage'


echo "Sage already Running";


 sage -notebook


edit flag offensive delete link more


Your grep might fail sometime, as it did for me. If some process are running which have sage in them, e.g. "message" then this fails. To avoid failure one could do a complex grep such as:

ps aux | grep sage | grep python | grep -v cleaner

The "cleaner" is added at the end to discount the "sage-cleaner" process which might be running even if the sage server is not running.

shivams gravatar imageshivams ( 2015-04-22 23:38:12 -0500 )edit

answered 2011-12-28 06:06:41 -0500

Emil Widmann gravatar image

updated 2011-12-28 06:10:27 -0500

There is the following in the Sage FAQ

QUESTION: How do I run sage in daemon mode, i.e. as a service?

ANSWER: We currently do not have a ready-to-go solution. There are several possibilities: Use screen, nohup or disown. We are tracking the issue at [] - so stay tuned.

Hmm, this ticket is 5 years old, so I guess there is no full daemon mode available anywhere soon. But I guess you are satisfied with something simpler.

1) Make a startscript (assuming $SAGE_ROOT is in your path, else use full path) which just contains:

sage -notebook

make it executable and klick on it in the GUI - the notebook server should start without terminal emulator.

2) Depending which Linux variant you use there should be alternative terminals available. E.g I can switch with Ctr-Alt-F1/F2/F3 between 3 different terminals. (On my system F1 has the default X session and F4 switches to the GUI, but that might be different for your system). But I can press Ctrl-Alt-F2, then log in with username/password, then start the sage notebook server (simplest with sage -notebook), and then go back with Ctrl-Alt-F4 to the GUI. The sage server is then running on tty2, I can use localhost:8000 in the X-session to log in to the notebook without any open terminal there.

there will be more sophisticated variants of course...

edit flag offensive delete link more


Hm - in the last Live CD I made the start script - option 1) - autoexec at system start (e.g. put the start script in /etc/profile.d), so it will be always there in the background. you can always check if it is running with the ps -a command. there should be 3 consecutive python processes. to stop: kill ID_OF_3d_PYTHONPROCESS

Emil Widmann gravatar imageEmil Widmann ( 2011-12-28 06:56:03 -0500 )edit

answered 2012-03-08 08:21:24 -0500

this post is marked as community wiki

This post is a wiki. Anyone with karma >750 is welcome to improve it.

Create the file /etc/init.d/sage_daemon (chmod 755) with the following content:

# configuration
SAGE_OPTS="-notebook interface='' secure=True"
# commands
sage_start() {
        $CMD_ECHO "Starting Sage..."
        $SAGE_HOME/sage $SAGE_OPTS >> $SAGE_LOG 2>&1 &
sage_stop() {
        $CMD_ECHO "Stopping Sage..."
        # CAUTION : maybe you kill something important in your server
        $CMD_KILLALL python
case $1 in
                $CMD_SLEEP 5
                $CMD_ECHO "Use: $0 {start|stop|restart}"
                exit 1
exit 0

Configure $CMD_* according to your Unix/Linux environment (use "which" command to locate the right paths). In order to automatically start the service (Debian) when the server starts, you should run this command:

/etc/init.d# update-rc.d sage_daemon defaults 95

Hope it'd be useful for other people too.

edit flag offensive delete link more


Oh, I've just forgot the most important command: /etc/init.d/sage_daemon start, and you are ready to go.

Guille gravatar imageGuille ( 2012-03-08 08:26:13 -0500 )edit

The `stop` command can use some love in this script. The process ID of the notebook serving process gets saved (you can tell by the fact that trying to start the notebook twice gives you an error message). Something like SAGE_PID="/home/sage/public.sagenb/" kill `cat $SAGE_PID` would probably exit the notebook a little more cleanly (you'd have to look up the name and location of the pid file on your system, though)

nbruin gravatar imagenbruin ( 2012-09-04 12:50:47 -0500 )edit

Another thing is that the script should really run sage under a UID different from root. So, in sage_start you might want to do /bin/su - sageserver "$SAGE_HOME/sage $SAGE_OPTS >> $SAGE_LOG 2>&1 &" where sageserver is an appropriate user on your system.

nbruin gravatar imagenbruin ( 2012-09-04 12:58:29 -0500 )edit

answered 2014-07-23 10:39:41 -0500

Woodgnome gravatar image

While there's an accepted answer for this question it's also worth checking out

edit flag offensive delete link more

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools


Asked: 2011-12-28 03:48:14 -0500

Seen: 1,669 times

Last updated: Jul 23 '14