Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
_static
Makefile
README.md
architecture-draw.io.xml
architecture.svg
conf.py
embedding.rst
forking_kernel_manager.rst
future.rst
index.rst
interact_protocol.rst
js.rst
make.bat
messages.md
releases.rst
sep_interacts.md
session.md
timing.rst
todo.rst
trusted_kernel_manager.rst
web_server.rst
web_service.rst

README.md

This is SageMathCell - a Sage computation web service.

Our mailing list is https://groups.google.com/forum/#!forum/sage-cell

Security Warning

If you are going to run a world accessible SageMathCell server, you must understand security implications and should be able to implement reasonable precautions.

The worker account (which is your own one by default) will be able to execute arbitrary code, which may be malicious. Make sure that you are securing the account properly. Working with a professional IT person is a very good idea here. Since the untrusted accounts can be on any computer, one way to isolate these accounts is to host them in a virtual machine that can be reset if the machine is compromised.

Simple Installation

We assume that you have access to the Internet and can install any needed dependencies. If you need to know more precisely what tools are needed, please consult the scripts for building virtual machine images in contib/vm. In particular, system packages installed in the base container are listed here.

  1. Install required npm packages:

    sudo apt-get install npm
    # On Debian based systems we need to make an alias
    sudo ln -s /usr/bin/nodejs /usr/bin/node
    sudo npm install -g requirejs
  2. Optionally create a directory for all components:

    mkdir sc_build
    cd sc_build
  3. Get and build Sage (export MAKE="make -j8" or something similar can speed things up):

    git clone https://github.com/novoselt/sage.git
    pushd sage
    git checkout sagecell
    make
    popd

    Note that we are building a special branch of Sage, do NOT use your regular Sage installation!

  4. Prepare Sage for SageMathCell:

    sage/sage -pip install --upgrade lockfile
    sage/sage -pip install --upgrade paramiko
    sage/sage -pip install --upgrade sockjs-tornado

    Note that version 1.0.3 of sockjs-tornado has a CORS issue fixed by https://github.com/mrjoes/sockjs-tornado/pull/83 You may delete these lines manually from sage/local/lib/python2.7/site-packages/sockjs/tornado/basehandler.py

  5. Build SageMathCell:

    git clone https://github.com/sagemath/sagecell.git
    pushd sagecell
    git submodule update --init --recursive
    ../sage/sage -sh -c make

Major JavaScript dependencies, including Require.js and CodeMirror.js, are copied from the Jupyter notebook bundled with SageMath.

Configuration

  1. Go into the sagecell directory (you are there in the end of the above instructions).

  2. Copy config_default.py to config.py. (Or fill config.py only with entries that you wish to change from default values.)

  3. Edit config.py according to your needs. Of particular interest are host and username entries of the _default_config dictionary: you should be able to SSH to username@host without typing in a password. For example, by default, it assumes you can do ssh localhost without typing in a password. Unless you are running a private and firewalled server for youself, you’ll want to change this to a more restrictive account; otherwise anyone will be able to execute any code under your username. You can set up a passwordless account using SSH: type “ssh passwordless login” into Google to find lots of guides for doing this, like http://www.debian-administration.org/articles/152. You may also wish to adjust db_config["uri"] (make the database files readable only by the trusted account).

  4. You may want to adjust log.py to suit your needs and/or adjust system configuration. By default logging is done via syslog which handles multiple processes better than plain files.

  5. Start the server via

    ../sage/sage web_server.py [-p <PORT_NUMBER>]

    where the default <PORT_NUMBER> is 8888 and go to http://localhost:<PORT_NUMBER> to use the Sage Cell server.

    When you want to shut down the server, press Ctrl-C in the same terminal.

License

See the LICENSE.txt file for terms and conditions for usage and a DISCLAIMER OF ALL WARRANTIES.

Browser Compatibility

SageMathCell is designed to be compatible with recent versions of:

  • Chrome
  • Firefox
  • Internet Explorer
  • Opera
  • Safari

If you notice issues with any of these browsers, please let us know.