CoCalc OnPrem 3.5.4

Note

These pages were created for version 3.5.4-874f9e5 as of Nov 07, 2024.

Welcome to CoCalc OnPrem!

CoCalc OnPrem (formerly known as “CoCalc Cloud”) is an on-premises self-hosted variant of CoCalc, which you can install on your own cluster. It offers the same powerful features as the online version and inherits the same reliable, salable performance our online platform is known for.

This version is designed specifically for companies and universities with their own computing infrastructure, providing scalability and full support for thousands of users. CoCalc OnPrem covers additional privacy requirements and provides complete infrastructure control, with the ability to customize the platform to meet your specific needs.

We are proud to have developed CoCalc OnPrem using the knowledge we’ve gained from running cocalc.com on Kubernetes since 2014.

Warning

If you are reading this online, you only see the generated documentation. The code and configuration files are proprietary and not available to the public.

If you are interested in CoCalc OnPrem, please contact Sagemath, Inc..

In a nutshell

  • CoCalc OnPrem runs 100% on your infrastructure. It requires a shared file-storage and a database.

  • Everything works via a modern web-browser. This means it is basically a web-service, running on top of Kubernetes.

  • It is self-contained, which means it can run behind a firewall, or even inside a VPN.

  • Users organize their work in collaborative projects (independent workspaces). A Projects is basically a container (Pod) inside of which users run their code, has adjustable resource limits, etc. It is equivalent to a user-account on a Linux server, although without elevated privileges.

  • Collaborators can be added to these projects, and everyone inside a project has equal access to all files in the project. Each file can be edited by several users with real-time synchronization. Processes run in the project’s containerized environment, common to all users.

  • Jupyter Notebooks: provide access to recent versions of Sage, Python 3, R, and Octave.

  • Like with the online version of CoCalc, users can edit both code and text files, compile LaTeX documents, use a Linux terminal, compile code, and utilize a virtual X11 desktop, run VS Code etc.

  • Installed software: there are various ways how you can extend, adapt or even replace the standard software environments to meet specific requirements. Users can switch the software environment for each project.

  • Support for single sign-on authentication, in particular SAML.

  • Networking is defined by standard Ingress rules.

  • You can deploy this solution on your own bare-metal cluster; managed clusters like Amazon’s AWS EKS or Google’s GCE GKE and other options should work as well.

News

  • 2024-08-30 3.4.0: default software environment based on Ubuntu 24.04, start of interface localization, many updates

Table of Contents

  • Overview – a high-level overview of CoCalc OnPrem, outlining its features and problems it solves.

  • Architecture – a high-level overview of the architecture of CoCalc OnPrem.

  • Setup – this is what you need to have in place in order to deploy CoCalc OnPrem.

  • Configuration – adjust default values of the HELM chart.

  • Deployment – this is the main step, deploying CoCalc OnPrem via HELM.

    Notes about deploy on public cloud providers:

  • Operations – notes about running CoCalc, and how to enable the “Prepull” service.

  • Release Notes – notes about updates, breaking changes, etc.