mirror of
https://github.com/jupyterhub/the-littlest-jupyterhub.git
synced 2025-12-18 21:54:05 +08:00
Add a quickstart tutorial & re-organize index page
We split docs into tutorials & more in-depth guides.
This commit is contained in:
53
docs/guides/admin.rst
Normal file
53
docs/guides/admin.rst
Normal file
@@ -0,0 +1,53 @@
|
||||
Administrative Access
|
||||
---------------------
|
||||
|
||||
In The Littlest JupyterHub, we try to allow users to do as many administrative
|
||||
tasks as possible within JupyterHub itself. Admin users can:
|
||||
|
||||
1. Have full root access with passwordless ``sudo``
|
||||
2. Install systemwide packages with ``apt``
|
||||
3. Install ``conda`` / ``pip`` packages for all JupyterHub
|
||||
4. Change amount of RAM / CPU available to each user and more!
|
||||
|
||||
By default, there are no admin users. You should add some after installation.
|
||||
|
||||
Adding admin users
|
||||
==================
|
||||
|
||||
Admin users are specified in the `YAML <https://en.wikipedia.org/wiki/YAML>`_
|
||||
config file at ``/opt/tljh/config.yaml``.
|
||||
|
||||
1. Open the ``config.yaml`` file for editing.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo nano /opt/tljh/config.yaml
|
||||
|
||||
2. Add usernames that should have admin access.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
users:
|
||||
admin:
|
||||
- user1
|
||||
- user2
|
||||
|
||||
Be careful around the syntax - indentation matters, and you should be using
|
||||
spaces and not tabs.
|
||||
|
||||
When you are done, save the file and exit. In ``nano``, you can do this with
|
||||
``Ctrl+X`` key.
|
||||
|
||||
3. When you are sure the format is ok, restart JupyterHub to let the config take
|
||||
effect.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo systemctl restart jupyterhub
|
||||
|
||||
This should give you admin access from JupyterHub! You can verify this by:
|
||||
|
||||
1. Opening a Terminal in your JupyterHub and checking if ``sudo`` works
|
||||
2. Opening your JupyterHub ``Control Panel`` and checking for the **Admin** tab
|
||||
|
||||
From now on, you can use the JupyterHub to do most configuration changes.
|
||||
42
docs/guides/install.rst
Normal file
42
docs/guides/install.rst
Normal file
@@ -0,0 +1,42 @@
|
||||
.. _installation:
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
Quick Installation
|
||||
------------------
|
||||
|
||||
The quick way to install The Littlest JupyterHub (tljh) is:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
curl https://raw.githubusercontent.com/yuvipanda/the-littlest-jupyterhub/master/installer/install.bash | sudo bash -
|
||||
|
||||
This takes 2-5 minutes to run. When completed, you can access your new JupyterHub
|
||||
at the public IP of your server!
|
||||
|
||||
You should probably add yourself as an `admin user <admin.md>`_
|
||||
after installation.
|
||||
|
||||
Slightly less quick installation
|
||||
--------------------------------
|
||||
|
||||
If you can read ``bash`` and are nervous about the previous installation method,
|
||||
you can inspect the installer script before running it.
|
||||
|
||||
|
||||
1. Download the installer script
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
curl https://raw.githubusercontent.com/yuvipanda/the-littlest-jupyterhub/master/installer/install.bash -o install.bash
|
||||
|
||||
2. Read the install script source using your favorite text editor
|
||||
|
||||
3. Run the installer script
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo install.bash
|
||||
|
||||
This should have the exact same effects as the quick installer method.
|
||||
15
docs/guides/requirements.rst
Normal file
15
docs/guides/requirements.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
.. _requirements:
|
||||
|
||||
Server Requirements
|
||||
===================
|
||||
|
||||
The Littlest JupyterHub (TLJH) can run on servers that meet at least he following criteria:
|
||||
|
||||
|
||||
#. Ubuntu Linux Operating System (minimum version supported 18.04)
|
||||
#. Full root access
|
||||
#. Access to the internet
|
||||
#. At least 512MB of RAM
|
||||
|
||||
While TLJH will run on machines that meet these requirements, you should also
|
||||
consider how much resources your individual users need before acquiring a server.
|
||||
Reference in New Issue
Block a user