Skip to content

Commit 81a600c

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent f43d02a commit 81a600c

File tree

10 files changed

+39
-54
lines changed

10 files changed

+39
-54
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ We have several tutorials to get you started.
3636
- Tutorials to create a new server from scratch on a cloud provider & run TLJH
3737
on it. These are **recommended** if you do not have much experience setting up
3838
servers.
39-
4039
- [Digital Ocean](https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/digitalocean.html)
4140
- [OVH](https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/ovh.html)
4241
- [Google Cloud](https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/google.html)

docs/contributing/dev-setup.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ The easiest & safest way to develop & test TLJH is with [Docker](https://www.doc
6161

6262
8. Make some changes to the repository. You can test easily depending on what
6363
you changed.
64-
6564
- If you changed the `bootstrap/bootstrap.py` script or any of its dependencies,
6665
you can test it by running `python3 /srv/src/bootstrap/bootstrap.py`.
6766
- If you changed the `tljh/installer.py` code (or any of its dependencies),

docs/howto/auth/awscognito.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ application to your `tljh` configuration.
2424
1. Create a user pool [Getting Started with User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/getting-started-with-cognito-user-pools.html).
2525

2626
When you have completed creating a user pool, app, and domain you should have the following settings available to you:
27-
2827
- **App client id**: From the App client page
2928

3029
- **App client secret** From the App client page

docs/howto/auth/github.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ You'll need a GitHub account in order to complete these steps.
2626
## Step 1: Create a GitHub application
2727

2828
1. Go to the [GitHub OAuth app creation page](https://github.com/settings/applications/new).
29-
3029
- **Application name**: Choose a descriptive application name (e.g. `tljh`)
3130

3231
- **Homepage URL**: Use the IP address or URL of your JupyterHub. e.g. `` http(s)://<my-tljh-url>` ``.

docs/howto/auth/google.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ and create a new project:
5151
```
5252

5353
- You will have to fill a form with:
54-
5554
- **Application type**: Choose _Web application_
5655

5756
- **Name**: A descriptive name for your OAuth client ID (e.g. `tljh-client`)

docs/howto/user-env/user-environment.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,6 @@ To upgrade the Python version of the user environment, one can:
180180
environment, but you may do so manually.
181181

182182
**Steps:**
183-
184183
1. Activate the user environment, if using ssh. If the terminal was
185184
started with JupyterHub, this step can be skipped:
186185

docs/install/azure.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
5151
```
5252
5353
5. **Choose an Ubuntu server for your VM**:
54-
5554
- Click `Ubuntu Server 22.04 LTS.`
5655
5756
- Make sure `Resource Manager` is selected in the next screen and click **Create**
@@ -61,7 +60,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
6160
```
6261
6362
6. Customise the Virtual Machine basics:
64-
6563
- **Subscription**. Choose the "Free Trial" if this is what you're using. Otherwise, choose a different plan. This is the billing account that will be charged.
6664
- **Resource group**. Resource groups let you keep your Azure tools/resources together in an availability region (e.g. WestEurope). If you already have one you'd like to use it select that resource.
6765
@@ -89,7 +87,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
8987
- **Inbound port rules**. Leave the defaults for now, and we will update these later on in the Network configuration step.
9088
9189
7. Before clicking on "Next" we need to select the RAM size for the image.
92-
9390
- For this we need to make sure we have enough RAM to accommodate your users. For example, if each user needs 2GB of RAM, and you have 10 total users, you need at least 20GB of RAM on the machine. It's also good to have a few GB of "buffer" RAM beyond what you think you'll need.
9491
9592
- Click on **Change size** (see image below)
@@ -105,7 +102,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
105102
- Select a suitable image (to check available images and prices in your region [click on this link](https://azuremarketplace.microsoft.com/en-gb/marketplace/apps/Canonical.UbuntuServer?tab=PlansAndPrice/?wt.mc_id=TLJH-github-taallard)).
106103
107104
8. Disks (Storage):
108-
109105
- **Disk options**: select the OS disk type there are options for SDD and HDD. **SSD persistent disk** gives you a faster but more expensive disk than HDD.
110106
111107
- **Data disk**. Click on create and attach a new disk. Select an appropriate type and size and click ok.
@@ -120,7 +116,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
120116
```
121117
122118
9. Networking
123-
124119
- **Virtual network**. Leave the default values selected.
125120
- **Subnet**. Leave the default values selected.
126121
- **Public IP address**.Leave the default values selected. This will make your server accessible from a browser.
@@ -132,9 +127,7 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
132127
```
133128
134129
10. Management
135-
136130
- Monitoring
137-
138131
- **Boot diagnostics**. Choose "On".
139132
- **OS guest diagnostics**. Choose "Off".
140133
- **Diagnostics storage account**. Leave as the default.
@@ -150,7 +143,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
150143
```
151144
152145
11. Advanced settings
153-
154146
- **Extensions**. Make sure there are no extensions listed
155147
- **Cloud init**. We are going to use this section to install TLJH directly into our Virtual Machine.
156148
@@ -177,7 +169,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
177169
12. Check the summary and confirm the creation of your Virtual Machine.
178170
179171
13. Check that the creation of your Virtual Machine worked.
180-
181172
- Wait for the virtual machine to be created. This might take about 5-10 minutes.
182173
183174
- After completion, you should see a similar screen to the one below:

docs/install/jetstream.md

Lines changed: 39 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ users and a user environment with packages you want installed running on
1717

1818
We'll create a new Jetstream 2 virtual machine and have it automatically install The Littlest JupyterHub (TLJH) at first boot.
1919

20-
1. Log in to the [Jetstream 2 portal](https://use.jetstream-cloud.org/). You must have (and select) an allocation in order to launch instances. Click the allocation you want to charge.
21-
2. Click **Create****Instance**.
22-
3. From the list of images, select **Ubuntu 24.04** (Jammy or newer is required for current TLJH releases).
23-
4. In the **Create Instance** dialog:
20+
1. Log in to the [Jetstream 2 portal](https://use.jetstream-cloud.org/). You must have (and select) an allocation in order to launch instances. Click the allocation you want to charge.
21+
2. Click **Create****Instance**.
22+
3. From the list of images, select **Ubuntu 24.04** (Jammy or newer is required for current TLJH releases).
23+
4. In the **Create Instance** dialog:
2424
1. Set a descriptive **Instance Name** (this is used in the default hostname and helps users recognize it).
2525
2. Choose an **Instance Size**. We suggest `m3.small` (2 vCPUs / 8 GiB RAM) or larger for more than a couple of users. The absolute minimum TLJH can start with is about **1 GiB** RAM, but you'll quickly run out with real workloads.
26-
- See the resource estimation guide: [Choosing resources](/howto/admin/resource-estimation) for help picking CPU, RAM, and disk.
26+
- See the resource estimation guide: [Choosing resources](/howto/admin/resource-estimation) for help picking CPU, RAM, and disk.
2727
3. (Optional) Increase the **Volume Size** if you expect many users or large datasets. You can not easily shrink later.
28-
5. Expand **Advanced Options**, then locate the **Boot Script** field. Replace any placeholder content with the following script (the whole content should just be this):
28+
5. Expand **Advanced Options**, then locate the **Boot Script** field. Replace any placeholder content with the following script (the whole content should just be this):
2929

3030
```bash
3131
#!/bin/bash
@@ -40,21 +40,23 @@ We'll create a new Jetstream 2 virtual machine and have it automatically install
4040
Notes:
4141
- The script runs only once, during the initial boot.
4242
- Keep it minimal—adding extra commands often slows install or causes failures if something prompts for input.
43-
6. Launch the instance (click **Create Instance** / **Launch**).
44-
7. You'll return to the instances dashboard. Your new instance will transition through provisioning states. It generally takes about 5 minutes for the TLJH install to finish after the VM first reports as active.
45-
8. Once the status shows **Ready** (or the VM indicates it is running), copy the displayed **Hostname**. It looks like:
43+
44+
6. Launch the instance (click **Create Instance** / **Launch**).
45+
7. You'll return to the instances dashboard. Your new instance will transition through provisioning states. It generally takes about 5 minutes for the TLJH install to finish after the VM first reports as active.
46+
8. Once the status shows **Ready** (or the VM indicates it is running), copy the displayed **Hostname**. It looks like:
4647
4748
yourinstancename.xxx0000000.projects.jetstream-cloud.org
4849
4950
Here `xxx0000000` is your allocation ID.
50-
9. Open that hostname in a web browser (http on port 80). You should see the JupyterHub login page. Your browser will warn about the site not being secure (no HTTPS)—we'll enable HTTPS in the next step.
51+
52+
9. Open that hostname in a web browser (http on port 80). You should see the JupyterHub login page. Your browser will warn about the site not being secure (no HTTPS)—we'll enable HTTPS in the next step.
5153
10. Log in with the `<admin-user-name>` you used in the boot script. Since this is the first login, you'll be prompted to set a password. Choose a strong password and store it safely. This password is now the credential for that admin user.
5254
11. (Optional) Verify the install by SSHing to the instance as `exouser` (Jetstream's default user):
53-
```bash
54-
55-
sudo tljh-config show | grep version || echo "Version not yet recorded (install still running?)"
56-
```
57-
If the install is still finishing you may briefly get a 503 proxy error or the version line may not appear yet—wait another minute and try again.
55+
```bash
56+
57+
sudo tljh-config show | grep version || echo "Version not yet recorded (install still running?)"
58+
```
59+
If the install is still finishing you may briefly get a 503 proxy error or the version line may not appear yet—wait another minute and try again.
5860
12. You now have a working JupyterHub. Continue below to secure it with HTTPS.
5961

6062
## Step 2: Enable HTTPS
@@ -64,34 +66,35 @@ Encrypted (HTTPS) access is strongly recommended before inviting users.
6466
See the full guide: [Enable HTTPS](/howto/admin/https). Below is a quick recipe for using the default Jetstream-provided hostname.
6567

6668
1. SSH to the instance as `exouser`:
67-
```bash
68-
69-
```
69+
```bash
70+
71+
```
7072
2. Configure Let's Encrypt (replace with a real email you control):
71-
```bash
72-
sudo tljh-config set https.enabled true
73-
sudo tljh-config set https.letsencrypt.email [email protected]
74-
sudo tljh-config add-item https.letsencrypt.domains yourinstancename.xxx0000000.projects.jetstream-cloud.org
75-
sudo tljh-config reload proxy
76-
```
73+
```bash
74+
sudo tljh-config set https.enabled true
75+
sudo tljh-config set https.letsencrypt.email [email protected]
76+
sudo tljh-config add-item https.letsencrypt.domains yourinstancename.xxx0000000.projects.jetstream-cloud.org
77+
sudo tljh-config reload proxy
78+
```
7779
3. Wait ~30–60 seconds, then reload the site using https://. If certificate issuance fails, check the logs:
78-
```bash
79-
sudo journalctl -u traefik --since "10 minutes ago" | grep -i acme
80-
```
80+
```bash
81+
sudo journalctl -u traefik --since "10 minutes ago" | grep -i acme
82+
```
8183
8284
Tips:
83-
* Make sure ports 80 and 443 are open in your Jetstream security group (they are open by default for new projects; adjust only if you customized network policies).
84-
* If you later attach a custom domain, add it with another `add-item` command and reload the proxy again.
85+
86+
- Make sure ports 80 and 443 are open in your Jetstream security group (they are open by default for new projects; adjust only if you customized network policies).
87+
- If you later attach a custom domain, add it with another `add-item` command and reload the proxy again.
8588
8689
## Step 3: Customize your JupyterHub deployment
8790
8891
Next common tasks:
8992
90-
* Add additional users or admins: [User management](/howto/admin/add-users)
91-
* Install Python / conda packages for all users: [Customize user environment](/howto/user-env)
92-
* Install optional system packages: `sudo apt install <package>` (restart user servers afterwards)
93-
* Pre-install JupyterLab extensions: see [Enable extensions](/howto/admin/enable-extensions)
94-
* Update TLJH itself: [Upgrading TLJH](/topic/installer-upgrade-actions)
93+
- Add additional users or admins: [User management](/howto/admin/add-users)
94+
- Install Python / conda packages for all users: [Customize user environment](/howto/user-env)
95+
- Install optional system packages: `sudo apt install <package>` (restart user servers afterwards)
96+
- Pre-install JupyterLab extensions: see [Enable extensions](/howto/admin/enable-extensions)
97+
- Update TLJH itself: [Upgrading TLJH](/topic/installer-upgrade-actions)
9598
9699
Browse the full How-To index for more: [/howto/index](/howto/index)
97100
@@ -110,5 +113,5 @@ When asking for help about TLJH, it is often useful to provide:
110113
- Your TLJH version (`sudo tljh-config show | grep version` if present in config) and the output of `lsb_release -a` for the OS
111114
- Any custom installer flags or `tljh-config` changes you have applied
112115
113-
This information helps others debug and answer more quickly sudo journalctl -u traefik --since "10 minutes ago" | grep -i acme
114-
.
116+
This information helps others debug and answer more quickly sudo journalctl -u traefik --since "10 minutes ago" | grep -i acme
117+
.

docs/topic/whentouse.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,9 @@ container technology in administering user sessions.
2222
The choice between TLJH and Z2JH ultimately comes down to only a few questions:
2323

2424
1. Do you want your hub and all users to live on a **single, larger machine** vs. spreading users on a **cluster of smaller machines** that are scaled up or down?
25-
2625
- If you can use a single machine, we recommend **The Littlest JupyterHub**.
2726
- If you wish to use multiple machines, we recommend **Zero to JupyterHub for Kubernetes**.
2827

2928
2. Do you **need to use container technology**?
30-
3129
- If no, we recommend **The Littlest JupyterHub**.
3230
- If yes, we recommend **Zero to JupyterHub for Kubernetes**.

docs/troubleshooting/logs.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ easier. Here are some very basic tips on effective `journalctl` usage.
8181
[less](<https://en.wikipedia.org/wiki/Less_(Unix)>). This allows you to
8282
scroll up / down, search for specific words, etc. Some common keyboard shortcuts
8383
are:
84-
8584
- Arrow keys to move up / down / left / right
8685
- `G` to navigate to the end of the logs
8786
- `g` to navigate to the start of the logs

0 commit comments

Comments
 (0)