mirror of
https://github.com/jupyterhub/the-littlest-jupyterhub.git
synced 2025-12-18 21:54:05 +08:00
Merge remote-tracking branch 'upstream/master'
This commit is contained in:
Tania Allard
@@ -16,10 +16,8 @@ to 1-50 users on a single server.
|
||||
|
||||
Administrators who do not consider themselves 'system administrators' but would
|
||||
like to provide hosted Jupyter Notebooks for their students / users are the
|
||||
primary audience. All users get the same environment, and administrators can
|
||||
install libraries into this environment without any specialized knowledge.
|
||||
It provides all users with the same environment, and administrators can install
|
||||
libraries into this environment easily without any specialized knowledge.
|
||||
primary audience. All users are provided with the same environment, and administrators
|
||||
can easily install libraries into this environment without any specialized knowledge.
|
||||
|
||||
See `this blog post <http://words.yuvi.in/post/the-littlest-jupyterhub/>`_ for
|
||||
more information.
|
||||
@@ -45,7 +43,7 @@ Ubuntu 18.04. We have a bunch of tutorials to get you started!
|
||||
- `Digital Ocean <https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/digitalocean.html>`_
|
||||
- `Google Cloud <https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/google.html>`_
|
||||
- `Jetstream <https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/jetstream.html>`_
|
||||
- `Amazon Web Services <https://aws.amazon.com/>`_
|
||||
- `Amazon Web Services <https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/amazon.html>`_
|
||||
- ... your favorite provider here, if you can contribute!
|
||||
|
||||
- `Tutorial to install TLJH on an already running server you have root access to
|
||||
|
||||
4
docs/_static/custom.css
vendored
4
docs/_static/custom.css
vendored
@@ -1,3 +1,3 @@
|
||||
div.sphinxsidebarwrapper h1.logo {
|
||||
font-size: 2.3rem;
|
||||
div.toctree-wrapper p.caption {
|
||||
display: none;
|
||||
}
|
||||
|
||||
@@ -56,6 +56,7 @@ if os.path.exists(os.path.join(here, '_static')):
|
||||
html_sidebars = {
|
||||
'**': [
|
||||
'about.html',
|
||||
'globaltoc.html',
|
||||
'relations.html',
|
||||
'searchbox.html',
|
||||
'donate.html',
|
||||
@@ -74,3 +75,6 @@ html_theme_options = {
|
||||
'github_banner': False,
|
||||
'github_type': 'star',
|
||||
}
|
||||
|
||||
def setup(app):
|
||||
app.add_stylesheet('custom.css')
|
||||
@@ -13,13 +13,11 @@ the cloud provider of your choice.
|
||||
|
||||
Currently there are instructions to resize your resources on the following providers:
|
||||
|
||||
* :ref:`Digital Ocean <digitalocean/resize>`.
|
||||
* :ref:`Digital Ocean <howto/providers/digitalocean/resize>`.
|
||||
|
||||
Once resources have been reallocated, you must tell TLJH to make use of these resources,
|
||||
and verify that the resources have become available.
|
||||
|
||||
.. _tljhconf:
|
||||
|
||||
Verifying a Resize
|
||||
==================
|
||||
|
||||
|
||||
43
docs/howto/providers/digitalocean.rst
Normal file
43
docs/howto/providers/digitalocean.rst
Normal file
@@ -0,0 +1,43 @@
|
||||
.. _howto/providers/digitalocean:
|
||||
|
||||
================================================
|
||||
Perform common Digital Ocean configuration tasks
|
||||
================================================
|
||||
|
||||
This page lists various common tasks you can perform on your
|
||||
Digital Ocean virtual machine.
|
||||
|
||||
.. _howto/providers/digitalocean/resize:
|
||||
|
||||
Resizing your droplet
|
||||
=====================
|
||||
|
||||
As you use your JupyterHub, you may find that you need more memory,
|
||||
disk space, or CPUs. Digital Ocean servers can be resized in the
|
||||
"Resize Droplet" panel. These instructions take you through the process.
|
||||
|
||||
#. First, click on the name of your newly-created
|
||||
Droplet to enter its configuration page.
|
||||
|
||||
#. Next, **turn off your Droplet**. This allows DigitalOcean to make
|
||||
modifications to your VM. This will shut down your JupyterHub (temporarily).
|
||||
|
||||
.. image:: ../../images/providers/digitalocean/power-off.png
|
||||
:alt: Power off your Droplet
|
||||
:width: 200px
|
||||
|
||||
#. Once your Droplet has been turned off, click "Resize",
|
||||
which will take you to a menu with options to resize your VM.
|
||||
|
||||
.. image:: ../../images/providers/digitalocean/resize-droplet.png
|
||||
:alt: Resize panel of digital ocean
|
||||
|
||||
#. Decide what kinds of resources you'd like to resize, then click on a new VM
|
||||
type in the list below. Finally, click "Resize". This may take a few moments!
|
||||
|
||||
#. Once your Droplet is resized, **turn your Droplet back on**. This makes your JupyterHub
|
||||
available to the world once again. This will take a few moments to complete.
|
||||
|
||||
Now that you've resized your Droplet, you may want to change the resources available
|
||||
to your users. Further information on making more resources available to
|
||||
users and verifying resource availability can be found in :ref:`howto/admin/resize`.
|
||||
@@ -10,10 +10,9 @@ a small (0-100) number of users on a single server. We recommend reading
|
||||
Development Status
|
||||
==================
|
||||
|
||||
This project is currently in **alpha** state. Most things work, but we might
|
||||
still make breaking changes that have no clear upgrade pathway. We are targeting
|
||||
a v0.1 release sometime in mid-August 2018. Follow `this milestone <https://github.com/jupyterhub/the-littlest-jupyterhub/milestone/1>`_
|
||||
to see progress towards the release!
|
||||
This project is currently in **beta** state. Folks have been using installations
|
||||
of TLJH for more than a year now to great success. While we try hard not to, we
|
||||
might still make breaking changes that have no clear upgrade pathway.
|
||||
|
||||
Installation
|
||||
============
|
||||
@@ -28,6 +27,7 @@ We have a bunch of tutorials to get you started.
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:caption: Installation
|
||||
|
||||
install/digitalocean
|
||||
install/jetstream
|
||||
@@ -48,6 +48,7 @@ Content and Data
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:caption: Content and data
|
||||
|
||||
howto/content/nbgitpuller
|
||||
howto/content/add-data
|
||||
@@ -58,6 +59,7 @@ The user environment
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:caption: The user environment
|
||||
|
||||
howto/env/user-environment
|
||||
howto/env/notebook-interfaces
|
||||
@@ -72,6 +74,7 @@ with your JupyterHub. For more information on Authentication, see
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:caption: Authentication
|
||||
|
||||
howto/auth/dummy
|
||||
howto/auth/github
|
||||
@@ -83,6 +86,7 @@ Administration and security
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:caption: Administration and security
|
||||
|
||||
howto/admin/admin-users
|
||||
howto/admin/resource-estimation
|
||||
@@ -91,6 +95,14 @@ Administration and security
|
||||
howto/admin/https
|
||||
howto/admin/enable-extensions
|
||||
|
||||
Cloud provider configuration
|
||||
----------------------------
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:caption: Cloud provider configuration
|
||||
|
||||
howto/providers/digitalocean
|
||||
|
||||
Topic Guides
|
||||
============
|
||||
@@ -99,6 +111,7 @@ Topic guides provide in-depth explanations of specific topics.
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:caption: Topic guides
|
||||
|
||||
topic/whentouse
|
||||
topic/requirements
|
||||
@@ -118,6 +131,7 @@ guides help you find what is broken & hopefully fix it.
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:caption: Troubleshooting
|
||||
|
||||
troubleshooting/logs
|
||||
|
||||
@@ -142,6 +156,7 @@ to people contributing in various ways.
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:caption: Contributing
|
||||
|
||||
contributing/docs
|
||||
contributing/code-review
|
||||
|
||||
@@ -116,40 +116,4 @@ Step 2: Adding more users
|
||||
Step 3: Install conda / pip packages for all users
|
||||
==================================================
|
||||
|
||||
.. include:: add_packages.txt
|
||||
|
||||
.. _digitalocean/resize:
|
||||
|
||||
Step 4: Resizing and editing the droplet
|
||||
========================================
|
||||
|
||||
As you use your JupyterHub, you may find that you need more memory,
|
||||
disk space, or CPUs. Digital Ocean servers can be resized in the
|
||||
"Resize Droplet" panel. These instructions take you through the process.
|
||||
|
||||
#. First, click on the name of your newly-created
|
||||
Droplet to enter its configuration page.
|
||||
|
||||
#. Next, **turn off your Droplet**. This allows DigitalOcean to make
|
||||
modifications to your VM. This will shut down your JupyterHub (temporarily).
|
||||
|
||||
.. image:: ../images/providers/digitalocean/power-off.png
|
||||
:alt: Power off your Droplet
|
||||
:width: 200px
|
||||
|
||||
#. Once your Droplet has been turned off, click "Resize",
|
||||
which will take you to a menu with options to resize your VM.
|
||||
|
||||
.. image:: ../images/providers/digitalocean/resize-droplet.png
|
||||
:alt: Resize panel of digital ocean
|
||||
|
||||
#. Decide what kinds of resources you'd like to resize, then click on a new VM
|
||||
type in the list below. Finally, click "Resize". This may take a few moments!
|
||||
|
||||
#. Once your Droplet is resized, **turn your Droplet back on**. This makes your JupyterHub
|
||||
available to the world once again. This will take a few moments to complete.
|
||||
|
||||
Now that you've resized your Droplet, you may want to change the resources available
|
||||
to your users. Further information on making more resources available to
|
||||
users and verifying resource availability can be found in :ref:`howto/admin/resize`.
|
||||
|
||||
.. include:: add_packages.txt
|
||||
@@ -189,9 +189,9 @@ def ensure_jupyterhub_package(prefix):
|
||||
and conda packages!
|
||||
"""
|
||||
conda.ensure_pip_packages(prefix, [
|
||||
'jupyterhub==0.9.5',
|
||||
'jupyterhub==0.9.6',
|
||||
'jupyterhub-dummyauthenticator==0.3.1',
|
||||
'jupyterhub-systemdspawner==0.11',
|
||||
'jupyterhub-systemdspawner==0.13',
|
||||
'jupyterhub-firstuseauthenticator==0.12',
|
||||
'jupyterhub-nativeauthenticator==0.0.4',
|
||||
'jupyterhub-ldapauthenticator==1.2.2',
|
||||
@@ -242,7 +242,7 @@ def ensure_user_environment(user_requirements_txt_file):
|
||||
|
||||
conda.ensure_pip_packages(USER_ENV_PREFIX, [
|
||||
# JupyterHub + notebook package are base requirements for user environment
|
||||
'jupyterhub==0.9.5',
|
||||
'jupyterhub==0.9.6',
|
||||
'notebook==5.7.8',
|
||||
# Install additional notebook frontends!
|
||||
'jupyterlab==0.35.4',
|
||||
|
||||
Reference in New Issue
Block a user