Skip to content

CoCalc Docker Image

Hal Snyder edited this page Aug 13, 2018 · 6 revisions

About the CoCalc Docker image

A Docker image of the CoCalc server is freely available. The CoCalc Docker image lets you:

  • run Sage worksheets and Python 2 Jupyter notebooks locally
  • edit LaTeX documents and markdown locally
  • learn about how CoCalc works

Note that files edited with the Docker image are fully compatible with online CoCalc. You can upload files from your Docker image to your cocalc.com account and work on them there. Files from cocalc.com will run in the Docker image as well, but you will need to ensure that any required packages and libraries are also installed locally.

Limitations

  1. Unlike the cocalc.com service, the Docker image doesn't isolate projects from each other and also has no provisions to scale horizontally. The service cocalc.com has a quite sophisticated management system based on kubernetes, which is proprietary. However, the docker image should still work for you on an average server node and without malicious users.
  2. The software stack behind the cocalc.com service is huge and well-tested. In comparison, the docker image only provides a small set of basic utilities. You can extend it on your own, though, by either installing more into the container or by amending the Dockerfile.
  3. SageMath, Inc. doesn't offer free support for the docker image. (But see below for alternatives.)
  4. The license is AGPLv3.

Questions

I'm working on a collaborative project on cocalc.com and the scripts we're using will very likely exceed the allotted server time for my cocalc.com account. Can I run the Docker image of CoCalc on my own machine, but still enable access by my collaborators remotely?

Yes, you definitely can! The CoCalc team does exactly this in some special cases. Follow the directions here: https://github.com/sagemathinc/cocalc-docker Be sure to make your account an admin and set an "account creation token" so that only you and your collab can make accounts on the server.

What support is available for the CoCalc Docker image?

If you want professional level support for running the server from us, send email to [[email protected]](mailto:[email protected]?subject=CoCalc Docker professional support). There's also a mailing list for general community discussion here: https://groups.google.com/forum/#!forum/cocalc And feel free to share your experiences.

Is Anaconda available in the CoCalc Docker image?

The Docker image does NOT currently include Anaconda at all. If you need it, you'll have to install it yourself.

What about compatibility with the operating system on my local computer?

The CoCalc Docker image, is completely isolated from your main Linux system. It can't mess up anything installed there! It uses the exact same kernel, and has minimal overhead (it is very much not a virtual machine), but will definitely not touch or break anything related to your OS.

How much disk space is needed for the CoCalc Docker image?

About 7 GB.

Getting Started

Detailed instructions to get the image up and running are at the github repo for sagemathinc/cocalc-docker.

Clone this wiki locally