zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

markdownify add_users/packages included files

Browse Source 
not caught in initial rst2myst
This commit is contained in:
Min RK
2023-03-27 10:22:35 +02:00
parent 76dadd7ef9
commit 1ac6f9983d
9 changed files with 101 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/install/add_packages.txt
View File

@@ -1,30 +1,30 @@
The **User Environment** is a conda environment that is shared by all users
in the JupyterHub. Libraries installed in this environment are immediately
available to all users. Admin users can install packages in this environment
with ``sudo -E``.
#. Log in as an admin user and open a Terminal in your Jupyter Notebook.
.. image:: ../images/notebook/new-terminal-button.png
:alt: New Terminal button under New menu
#. Install `gdal <https://anaconda.org/conda-forge/gdal>`_ from `conda-forge <https://conda-forge.org/>`_.
.. code-block:: bash
sudo -E conda install -c conda-forge gdal
The ``sudo -E`` is very important!
#. Install `there <https://pypi.org/project/there>`_ with ``pip``
.. code-block:: bash
sudo -E pip install there
The packages ``gdal`` and ``there`` are now available to all users in JupyterHub.
If a user already had a python notebook running, they have to restart their notebook's
kernel to make the new libraries available.
See :ref:`howto-env-user-environment` for more information.
The **User Environment** is a conda environment that is shared by all users
in the JupyterHub. Libraries installed in this environment are immediately
available to all users. Admin users can install packages in this environment
with `sudo -E`.
1. Log in as an admin user and open a Terminal in your Jupyter Notebook.
```{image} ../images/notebook/new-terminal-button.png
:alt: New Terminal button under New menu
```
2. Install [gdal](https://anaconda.org/conda-forge/gdal) from [conda-forge](https://conda-forge.org/).
```bash
sudo -E conda install -c conda-forge gdal
```
The `sudo -E` is very important!
3. Install [there](https://pypi.org/project/there) with `pip`
```bash
sudo -E pip install there
```
The packages `gdal` and `there` are now available to all users in JupyterHub.
If a user already had a python notebook running, they have to restart their notebook's
kernel to make the new libraries available.
See {ref}`howto-env-user-environment` for more information.

82
docs/install/add_users.txt
View File

@@ -1,39 +1,43 @@
Most administration & configuration of the JupyterHub can be done from the
web UI directly. Let's add a few users who can log in!
#. Open the **Control Panel** by clicking the control panel button on the top
right of your JupyterHub.
.. image:: ../images/control-panel-button.png
:alt: Control panel button in notebook, top right
#. In the control panel, open the **Admin** link in the top left.
.. image:: ../images/admin/admin-access-button.png
:alt: Admin button in control panel, top left
This opens up the JupyterHub admin page, where you can add / delete users,
start / stop peoples' servers and see who is online.
#. Click the **Add Users** button.
.. image:: ../images/admin/add-users-button.png
:alt: Add Users button in the admin page
A **Add Users** dialog box opens up.
#. Type the names of users you want to add to this JupyterHub in the dialog box,
one per line.
.. image:: ../images/admin/add-users-dialog.png
:alt: Adding users with add users dialog
You can tick the **Admin** checkbox if you want to give admin rights to all
these users too.
#. Click the **Add Users** button in the dialog box. Your users are now added
to the JupyterHub! When they log in for the first time, they can set their
password - and use it to log in again in the future.
Congratulations, you now have a multi user JupyterHub that you can add arbitrary
users to!
Most administration & configuration of the JupyterHub can be done from the
web UI directly. Let's add a few users who can log in!
1. Open the **Control Panel** by clicking the control panel button on the top
right of your JupyterHub.
```{image} ../images/control-panel-button.png
:alt: Control panel button in notebook, top right
```
2. In the control panel, open the **Admin** link in the top left.
```{image} ../images/admin/admin-access-button.png
:alt: Admin button in control panel, top left
```
This opens up the JupyterHub admin page, where you can add / delete users,
start / stop peoples' servers and see who is online.
3. Click the **Add Users** button.
```{image} ../images/admin/add-users-button.png
:alt: Add Users button in the admin page
```
A **Add Users** dialog box opens up.
4. Type the names of users you want to add to this JupyterHub in the dialog box,
one per line.
```{image} ../images/admin/add-users-dialog.png
:alt: Adding users with add users dialog
```
You can tick the **Admin** checkbox if you want to give admin rights to all
these users too.
5. Click the **Add Users** button in the dialog box. Your users are now added
to the JupyterHub! When they log in for the first time, they can set their
password - and use it to log in again in the future.
Congratulations, you now have a multi user JupyterHub that you can add arbitrary
users to!

8
docs/install/amazon.md
View File

@@ -268,12 +268,12 @@ Let's create the server on which we can run JupyterHub.
## Step 2: Adding more users
```{eval-rst}
.. include:: add_users.txt
```{include} add_users.txt
```
## Step 3: Install conda / pip packages for all users
```{eval-rst}
.. include:: add_packages.txt
```{include} add_packages.txt
```

8
docs/install/azure.md
View File

@@ -207,12 +207,12 @@ A new screen with all the options for Virtual Machines in Azure will displayed.
## Step 2: Adding more users
```{eval-rst}
.. include:: add_users.txt
```{include} add_users.txt
```
## Step 3: Install conda / pip packages for all users
```{eval-rst}
.. include:: add_packages.txt
```{include} add_packages.txt
```

8
docs/install/custom-server.md
View File

@@ -79,14 +79,14 @@ for custom server installations.
## Step 2: Adding more users
```{eval-rst}
.. include:: add_users.txt
```{include} add_users.txt
```
## Step 3: Install conda / pip packages for all users
```{eval-rst}
.. include:: add_packages.txt
```{include} add_packages.txt
```
## Step 4: Setup HTTPS

8
docs/install/digitalocean.md
View File

@@ -112,12 +112,12 @@ Let's create the server on which we can run JupyterHub.
## Step 2: Adding more users
```{eval-rst}
.. include:: add_users.txt
```{include} add_users.txt
```
## Step 3: Install conda / pip packages for all users
```{eval-rst}
.. include:: add_packages.txt
```{include} add_packages.txt
```

8
docs/install/google.md
View File

@@ -208,12 +208,12 @@ Let's create the server on which we can run JupyterHub.
## Step 2: Adding more users
```{eval-rst}
.. include:: add_users.txt
```{include} add_users.txt
```
## Step 3: Install conda / pip packages for all users
```{eval-rst}
.. include:: add_packages.txt
```{include} add_packages.txt
```

8
docs/install/jetstream.md
View File

@@ -141,12 +141,12 @@ Let's create the server on which we can run JupyterHub.
## Step 2: Adding more users
```{eval-rst}
.. include:: add_users.txt
```{include} add_users.txt
```
## Step 3: Install conda / pip packages for all users
```{eval-rst}
.. include:: add_packages.txt
```{include} add_packages.txt
```

8
docs/install/ovh.md
View File

@@ -122,12 +122,12 @@ Let's create the server on which we can run JupyterHub.
## Step 2: Adding more users
```{eval-rst}
.. include:: add_users.txt
```{include} add_users.txt
```
## Step 3: Install conda / pip packages for all users
```{eval-rst}
.. include:: add_packages.txt
```{include} add_packages.txt
```