mirror of
https://github.com/jupyterhub/the-littlest-jupyterhub.git
synced 2025-12-18 21:54:05 +08:00
Add docs on admin access
This commit is contained in:
52
docs/admin.md
Normal file
52
docs/admin.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# 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.
|
||||
|
||||
```bash
|
||||
sudo nano /opt/tljh/config.yaml
|
||||
```
|
||||
|
||||
2. Add usernames that should have admin access.
|
||||
|
||||
```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.
|
||||
|
||||
```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.
|
||||
@@ -21,3 +21,4 @@ makes you nervous, check out the [other installation methods](install.md) we sup
|
||||
|
||||
- [Server requirements](requirements.md)
|
||||
- [Installation](install.md)
|
||||
- [Administrative Access](admin.md)
|
||||
|
||||
@@ -10,6 +10,9 @@ curl https://raw.githubusercontent.com/yuvipanda/the-littlest-jupyterhub/master/
|
||||
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,
|
||||
|
||||
Reference in New Issue
Block a user