external/iiab
1
0
Fork 0
mirror of https://github.com/iiab/iiab.git synced 2025-03-09 15:40:17 +00:00
Code Issues Releases Wiki Activity

jupyterhub/README.md: Clarifs & new screenshots

Browse source
This commit is contained in:
A Holt 2023-02-08 12:17:19 -05:00 • committed by GitHub
parent b0f5a85e20
commit 872c77d728
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

13
roles/jupyterhub/README.md
View file

@ -9,7 +9,7 @@
* [JupyterHub changelog](https://jupyterhub.readthedocs.io/en/stable/changelog.html#changelog) * [JupyterHub changelog](https://jupyterhub.readthedocs.io/en/stable/changelog.html#changelog)
* Students create their own accounts on first use — e.g. at http://box.lan/jupyterhub — just as if they're logging in regularly (unfortunately the login screen doesn't make that clear, but the teacher _does not_ need to be involved!) * Students create their own accounts on first use — e.g. at http://box.lan/jupyterhub — just as if they're logging in regularly (unfortunately the login screen doesn't make that clear, but the teacher _does not_ need to be involved!)
* A student can then sign in with their username and password, to gain access to their files (Jupyter Notebooks). * A student can then sign in with their username and password, to gain access to their files (Jupyter Notebooks).
* The teacher should set and protect JupyterHub's overall `Admin` password, just in case. As with student accounts, the login screen doesn't make that clear — so just log in with username `Admin` — using any password that you want to become permanent. * The teacher should set and protect JupyterHub's overall `Admin` password, just in case. As with student accounts, the login screen unfortunately doesn't make that clear — so just log in with username `Admin` — using any password that you want to become permanent.
* Individual student folders are created in `/var/lib/private/` on the Internet-in-a-Box (IIAB) server: * Individual student folders are created in `/var/lib/private/` on the Internet-in-a-Box (IIAB) server:
* A student will only be able to see their own work — they do not have privileges outside of their own folder. * A student will only be able to see their own work — they do not have privileges outside of their own folder.
* Students may upload Jupyter Notebooks to the IIAB server, and download the current state of their work via a normal browser. * Students may upload Jupyter Notebooks to the IIAB server, and download the current state of their work via a normal browser.
@ -26,10 +26,11 @@ In some rare circumstances, it may be necessary to restart JupyterHub's systemd
sudo systemctl restart jupyterhub sudo systemctl restart jupyterhub
``` ```
FYI `/opt/iiab/jupyterhub` is a Python 3 virtual environment, that can be activated with the usual formula: FYI `/opt/iiab/jupyterhub` is a Python 3 virtual environment, that can be activated (and deactivated) with the usual:
``` ```
source /opt/iiab/jupyterhub/bin/activate source /opt/iiab/jupyterhub/bin/activate
(jupyterhub) root@box:~# deactivate
``` ```
Passwords are hashed using 4096 rounds of the latest Blowfish (bcrypt's $2b$ algorithm) and stored in: Passwords are hashed using 4096 rounds of the latest Blowfish (bcrypt's $2b$ algorithm) and stored in:
@ -48,13 +49,13 @@ NOTE: This is the only way to change the password for user 'Admin', because Cont
The `Admin` user (and any users given `Admin` privilege) can reset user passwords by deleting the user from JupyterHub's **Admin** page (below). This logs the user out, but does not remove any of their data or home directories. The user can then set a new password in the usual way — simply by logging in. Example: The `Admin` user (and any users given `Admin` privilege) can reset user passwords by deleting the user from JupyterHub's **Admin** page (below). This logs the user out, but does not remove any of their data or home directories. The user can then set a new password in the usual way — simply by logging in. Example:
1. As a user with `Admin` privilege, click **Control Panel** in the top right of your JupyterHub: 1. As a user with `Admin` privilege, click **File > Hub Control Panel** in your JupyterHub:
![Control panel button in notebook, top right](control-panel-button1.png) ![image](https://user-images.githubusercontent.com/2458907/217602766-ab6a9d3c-9f92-496e-a0e8-6c18a084e960.png)
2. In the Control Panel, open the **Admin** link in the top left: 2. At the top of the Control Panel, click **Admin**:
![Admin button in control panel, top left](admin-access-button1.png) ![image](https://user-images.githubusercontent.com/2458907/217602473-f4f9fd40-b4c1-45e1-88c5-54c6d4b604ff.png)
This opens up the JupyterHub Admin page, where you can add / delete users, start / stop peoples’ servers and see who is online. This opens up the JupyterHub Admin page, where you can add / delete users, start / stop peoples’ servers and see who is online.