Skip to content

Commit b9f7a6e

Browse files
committed
fmt: run prettier
1 parent f43d02a commit b9f7a6e

File tree

1 file changed

+39
-36
lines changed

1 file changed

+39
-36
lines changed

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+
.

0 commit comments

Comments
 (0)