CoCalc OnPrem |version|
========================================

.. note::

  These pages were created for version |release| as of |today|.


Welcome to `CoCalc OnPrem`_!
------------------------------------------------------------

`CoCalc OnPrem`_ (formerly known as "CoCalc Cloud") is an :term:`on-premises` self-hosted variant of :term:`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 <https://cocalc.com>`_ on :term:`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 :term:`Kubernetes`.
* It is self-contained, which means it can run behind a firewall, or even inside a :term:`VPN`.
* Users organize their work in **collaborative projects** (independent workspaces). A :ref:`project` is basically a container (:term:`Pod`) inside of which users run their code, has :ref:`adjustable resource limits <resource_management>`, etc. It is equivalent to a user-account on a Linux server, although without elevated privileges.
* `Collaborators can be added <https://doc.cocalc.com/users.html>`_ 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.
* :term:`Jupyter Notebooks <Jupyter Notebook>`:  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 <https://cocalc.com/features/latex-editor>`_, use a `Linux terminal <https://cocalc.com/features/terminal>`_, compile code, and utilize a `virtual X11 desktop <https://cocalc.com/features/x11>`_, run `VS Code <https://code.visualstudio.com/docs/remote/vscode-server>`_ etc.
* Installed software: there are :ref:`various ways <ops-software-env>` 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 :term:`SAML`.
* Networking is defined by standard :term:`Ingress rules <Ingress>`.
* You can deploy this solution on your own bare-metal cluster; managed clusters like `Amazon's AWS EKS <https://aws.amazon.com/eks/>`_ or `Google's GCE GKE <https://cloud.google.com/kubernetes-engine/>`_ 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
-------------------

.. toctree::
  :maxdepth: 1
  :hidden:

  overview
  architecture
  setup
  configuration
  deployment
  cloud
  ops
  release-notes


-  :doc:`Overview <overview>` – a high-level overview of CoCalc OnPrem, outlining its features and problems it solves.
-  :doc:`Architecture <architecture>` – a high-level overview of the architecture of CoCalc OnPrem.
-  :doc:`Setup <setup>` – this is what you need to have in place in order to deploy CoCalc OnPrem.
-  :doc:`Configuration <configuration>` – adjust default values of the :term:`HELM` chart.
-  :doc:`Deployment <deployment>` – this is the main step, deploying CoCalc OnPrem via :term:`HELM`.

   Notes about deploy on public cloud providers:

   -  :doc:`deploy/gke` – some configs and notes about deploying on an GKE cluster.
   -  :doc:`deploy/eks` – similar notes about deploying on an AWS EKS cluster.
   -  :doc:`deploy/aks` – how to deploy on Azure's AKS

-  :doc:`Operations <ops>` – notes about running CoCalc, and how to enable the :ref:`"Prepull" service <prepull>`.
-  :doc:`Release Notes <release-notes>` – notes about updates, breaking changes, etc.

.. toctree::
  :hidden:

  glossary
  genindex

.. _CoCalc OnPrem: https://cocalc.com/pricing/onprem
.. _contact Sagemath, Inc.: https://cocalc.com/support/new?hideExtra=true&type=purchase&subject=CoCalc%20Cloud%20Business&body=I%27m%20interested%20in%20puchasing%20CoCalc%20Cloud%20on-premises.&title=Purchase%20CoCalc-OnPrem
.. _help@cocalc.com: mailto:help@cocalc.com


Links
------------------------------------------------------------

- `CoCalc Documentation`_ – the documentation for the online version of CoCalc
- `CoCalc Feature Overview`_ – which explains all the features in detail


.. _CoCalc Documentation: https://doc.cocalc.com/
.. _CoCalc Feature Overview: https://cocalc.com/features