From 554c24b2d7ffc69320d4da7b9efcb1fd4c0cbc62 Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Sat, 21 Jul 2018 22:39:15 -0700 Subject: [PATCH] Fix requirements topic document --- docs/guides/requirements.rst | 41 ------------------------------------ docs/index.rst | 2 +- docs/topic/requirements.rst | 29 +++++++++++++++++++++++++ 3 files changed, 30 insertions(+), 42 deletions(-) delete mode 100644 docs/guides/requirements.rst create mode 100644 docs/topic/requirements.rst diff --git a/docs/guides/requirements.rst b/docs/guides/requirements.rst deleted file mode 100644 index fae4011..0000000 --- a/docs/guides/requirements.rst +++ /dev/null @@ -1,41 +0,0 @@ -.. _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:: - - Server RAM = ($N \times X) + 128MB - -The 128MB buffer is for system services (including JupyterHub itself). -This will guarantee that your server will not run out of RAM as long -as you have no more than ``N`` active users. diff --git a/docs/index.rst b/docs/index.rst index accedd5..f736999 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,7 +54,7 @@ Topic guides provide in-depth explanations of specific topics. .. toctree:: :titlesonly: - guides/requirements + topic/requirements guides/admin topic/security topic/customizing-installer diff --git a/docs/topic/requirements.rst b/docs/topic/requirements.rst new file mode 100644 index 0000000..a5caf1a --- /dev/null +++ b/docs/topic/requirements.rst @@ -0,0 +1,29 @@ +.. _requirements: + +=================== +Server Requirements +=================== + +Operating System +================ + +We require using Ubuntu 18.04 as the base operating system for your server. + +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. + +CPU / Memory / Disk Space +========================= + +See how to ref:`howto/resource-estimation`