docs/guides/requirements.rst

.. _requirements:

Server Requirements
===================

Operating System
----------------

We recommend using Ubuntu 18.04 as the base operating system for your server.
Ubuntu 16.04 should also work, but is not officially supported. other Linux
distributions and operating systems are also not officially supported.

Root access
-----------

Full ``root`` access to this server is required. This might be via ``sudo``
(recommended) or by direct access to ``root`` (not recommended!)

External IP
-----------

An external IP allows users on the internet to reach your JupyterHub. Most
VPS / Cloud providers give you a public IP address along with your server. If
you are hosting on a physical machine somewhere, talk to your system administrators
about how to get HTTP traffic from the world into your server.

Memory (RAM)
------------

RAM is often the biggest limiting factor to the question 'how many users can use this JupyterHub
at the same time?'. If you want to support ``N`` maximum concurrent active users
each able to use up to ``X`` GB of RAM, you will need.

.. math::

    ($N \times X) + 128MB

The 128MB buffer is for system services (including JupyterHub itself).
You can further reduce this number with overprovisioning if required.
Switch to sphinx+rtd for documentation - mkdocs doesn't support GFMD, so is a different dialect - recommonmark seems abandoned - Couldn't get m2r to work So RST + Sphinx it is! 2018-06-28 00:39:55 -07:00			`.. _requirements:`

			`Server Requirements`
			`===================`
Add docs with mkdocs There isn't going to be much code generation here, so let's start with mkdocs and see if it is good enough for us! 2018-06-27 16:33:14 -07:00
Update requirements doc to have more useful info 2018-06-28 02:53:32 -07:00			`Operating System`
			`----------------`
Add docs with mkdocs There isn't going to be much code generation here, so let's start with mkdocs and see if it is good enough for us! 2018-06-27 16:33:14 -07:00
Update requirements doc to have more useful info 2018-06-28 02:53:32 -07:00			`We recommend using Ubuntu 18.04 as the base operating system for your server.`
			`Ubuntu 16.04 should also work, but is not officially supported. other Linux`
			`distributions and operating systems are also not officially supported.`
Switch to sphinx+rtd for documentation - mkdocs doesn't support GFMD, so is a different dialect - recommonmark seems abandoned - Couldn't get m2r to work So RST + Sphinx it is! 2018-06-28 00:39:55 -07:00
Update requirements doc to have more useful info 2018-06-28 02:53:32 -07:00			`Root access`
			`-----------`
Add docs with mkdocs There isn't going to be much code generation here, so let's start with mkdocs and see if it is good enough for us! 2018-06-27 16:33:14 -07:00
Update requirements doc to have more useful info 2018-06-28 02:53:32 -07:00			Full ``root`` access to this server is required. This might be via ``sudo``
			(recommended) or by direct access to ``root`` (not recommended!)

			`External IP`
			`-----------`

			`An external IP allows users on the internet to reach your JupyterHub. Most`
			`VPS / Cloud providers give you a public IP address along with your server. If`
			`you are hosting on a physical machine somewhere, talk to your system administrators`
			`about how to get HTTP traffic from the world into your server.`

			`Memory (RAM)`
			`------------`

			`RAM is often the biggest limiting factor to the question 'how many users can use this JupyterHub`
			at the same time?'. If you want to support ``N`` maximum concurrent active users
			each able to use up to ``X`` GB of RAM, you will need.

			`.. math::`

			`($N \times X) + 128MB`

			`The 128MB buffer is for system services (including JupyterHub itself).`
			`You can further reduce this number with overprovisioning if required.`