You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/howto/auth/awscognito.md
-1Lines changed: 0 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,6 @@ application to your `tljh` configuration.
24
24
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).
25
25
26
26
When you have completed creating a user pool, app, and domain you should have the following settings available to you:
Copy file name to clipboardExpand all lines: docs/install/azure.md
-9Lines changed: 0 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
51
51
```
52
52
53
53
5. **Choose an Ubuntu server for your VM**:
54
-
55
54
- Click `Ubuntu Server 22.04 LTS.`
56
55
57
56
- 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
61
60
```
62
61
63
62
6. Customise the Virtual Machine basics:
64
-
65
63
- **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.
66
64
- **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.
67
65
@@ -89,7 +87,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
89
87
- **Inbound port rules**. Leave the defaults for now, and we will update these later on in the Network configuration step.
90
88
91
89
7. Before clicking on "Next" we need to select the RAM size for the image.
92
-
93
90
- 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.
94
91
95
92
- 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
105
102
- 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)).
106
103
107
104
8. Disks (Storage):
108
-
109
105
- **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.
110
106
111
107
- **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
120
116
```
121
117
122
118
9. Networking
123
-
124
119
- **Virtual network**. Leave the default values selected.
125
120
- **Subnet**. Leave the default values selected.
126
121
- **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
132
127
```
133
128
134
129
10. Management
135
-
136
130
- Monitoring
137
-
138
131
- **Boot diagnostics**. Choose "On".
139
132
- **OS guest diagnostics**. Choose "Off".
140
133
- **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
150
143
```
151
144
152
145
11. Advanced settings
153
-
154
146
- **Extensions**. Make sure there are no extensions listed
155
147
- **Cloud init**. We are going to use this section to install TLJH directly into our Virtual Machine.
156
148
@@ -177,7 +169,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
177
169
12. Check the summary and confirm the creation of your Virtual Machine.
178
170
179
171
13. Check that the creation of your Virtual Machine worked.
180
-
181
172
- Wait for the virtual machine to be created. This might take about 5-10 minutes.
182
173
183
174
- After completion, you should see a similar screen to the one below:
Copy file name to clipboardExpand all lines: docs/install/jetstream.md
+39-36Lines changed: 39 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,15 +17,15 @@ users and a user environment with packages you want installed running on
17
17
18
18
We'll create a new Jetstream 2 virtual machine and have it automatically install The Littlest JupyterHub (TLJH) at first boot.
19
19
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:
24
24
1. Set a descriptive **Instance Name** (this is used in the default hostname and helps users recognize it).
25
25
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.
27
27
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):
29
29
30
30
```bash
31
31
#!/bin/bash
@@ -40,21 +40,23 @@ We'll create a new Jetstream 2 virtual machine and have it automatically install
40
40
Notes:
41
41
- The script runs only once, during the initial boot.
42
42
- 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:
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.
51
53
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.
52
54
11. (Optional) Verify the install by SSHing to the instance as `exouser` (Jetstream's default user):
* 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.
85
88
86
89
## Step 3: Customize your JupyterHub deployment
87
90
88
91
Next common tasks:
89
92
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)
Copy file name to clipboardExpand all lines: docs/topic/whentouse.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,9 @@ container technology in administering user sessions.
22
22
The choice between TLJH and Z2JH ultimately comes down to only a few questions:
23
23
24
24
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
-
26
25
- If you can use a single machine, we recommend **The Littlest JupyterHub**.
27
26
- If you wish to use multiple machines, we recommend **Zero to JupyterHub for Kubernetes**.
28
27
29
28
2. Do you **need to use container technology**?
30
-
31
29
- If no, we recommend **The Littlest JupyterHub**.
32
30
- If yes, we recommend **Zero to JupyterHub for Kubernetes**.
0 commit comments