mirror of
https://github.com/jupyterhub/the-littlest-jupyterhub.git
synced 2025-12-18 21:54:05 +08:00
fix absolute refs
myst seems to create different refs than sphinx
This commit is contained in:
@@ -24,7 +24,7 @@ not to have _perfect_ documentation before merging a pull request. If you
|
|||||||
are new and not sure how to add documentation, other contributors will
|
are new and not sure how to add documentation, other contributors will
|
||||||
be happy to guide you.
|
be happy to guide you.
|
||||||
|
|
||||||
See {ref}`contributing/docs` for guidelines on writing documentation.
|
See [](/contributing/docs) for guidelines on writing documentation.
|
||||||
|
|
||||||
## Write tests
|
## Write tests
|
||||||
|
|
||||||
@@ -43,4 +43,4 @@ add more tests.
|
|||||||
If you are unsure what kind of tests to add for your pull request, other
|
If you are unsure what kind of tests to add for your pull request, other
|
||||||
contributors to the repo will be happy to help guide you!
|
contributors to the repo will be happy to help guide you!
|
||||||
|
|
||||||
See {ref}`contributing/tests` for guidelines on writing tests.
|
See [](/contributing/tests) for guidelines on writing tests.
|
||||||
|
|||||||
@@ -68,5 +68,5 @@ The easiest & safest way to develop & test TLJH is with [Docker](https://www.doc
|
|||||||
restart jupyterhub for them to take effect. `tljh-config reload hub`
|
restart jupyterhub for them to take effect. `tljh-config reload hub`
|
||||||
should do that.
|
should do that.
|
||||||
|
|
||||||
{ref}`troubleshooting/logs` has information on looking at various logs in the container
|
[](/troubleshooting/logs) has information on looking at various logs in the container
|
||||||
to debug issues you might have.
|
to debug issues you might have.
|
||||||
|
|||||||
@@ -59,7 +59,7 @@ If you encounter this error, it's likely that you are running inside a virtual e
|
|||||||
Error in "currentmodule" directive:
|
Error in "currentmodule" directive:
|
||||||
```
|
```
|
||||||
|
|
||||||
To get started contributing, you'll want to read the {ref}`reStructuredText reference <sphinx:rst-index>`
|
To get started contributing, you'll want to read the `reStructuredText reference <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`
|
||||||
|
|
||||||
Your locally-built documentation will be themed differently than the
|
Your locally-built documentation will be themed differently than the
|
||||||
documentation at [the-littlest-jupyterhub.readthedocs.io](https://the-littlest-jupyterhub.readthedocs.io).
|
documentation at [the-littlest-jupyterhub.readthedocs.io](https://the-littlest-jupyterhub.readthedocs.io).
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ stability required for a good plugin ecosystem.
|
|||||||
|
|
||||||
## Installing Plugins
|
## Installing Plugins
|
||||||
|
|
||||||
Include `--plugin <install_name>` in the Installer script. See {ref}`topic/customizing-installer` for more info.
|
Include `--plugin <install_name>` in the Installer script. See [](/topic/customizing-installer) for more info.
|
||||||
|
|
||||||
## Writing a simple plugins
|
## Writing a simple plugins
|
||||||
|
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ so attackers can not easily gain control of the system.
|
|||||||
:::{important}
|
:::{important}
|
||||||
You should make sure an admin user is present when you **install** TLJH
|
You should make sure an admin user is present when you **install** TLJH
|
||||||
the very first time. It is recommended that you also set a password
|
the very first time. It is recommended that you also set a password
|
||||||
for the admin at this step. The {ref}`--admin <topic/customizing-installer/admin>`
|
for the admin at this step. The [`--admin`] (/topic/customizing-installer/admin)
|
||||||
flag passed to the installer does this. If you had forgotten to do so, the
|
flag passed to the installer does this. If you had forgotten to do so, the
|
||||||
easiest way to fix this is to run the installer again.
|
easiest way to fix this is to run the installer again.
|
||||||
:::
|
:::
|
||||||
|
|||||||
@@ -8,9 +8,9 @@ HTTPS encrypts traffic so that usernames, passwords and your data are
|
|||||||
communicated securely. sensitive bits of information are communicated
|
communicated securely. sensitive bits of information are communicated
|
||||||
securely. The Littlest JupyterHub supports automatically configuring HTTPS
|
securely. The Littlest JupyterHub supports automatically configuring HTTPS
|
||||||
via [Let's Encrypt](https://letsencrypt.org), or setting it up
|
via [Let's Encrypt](https://letsencrypt.org), or setting it up
|
||||||
{ref}`manually <howto/admin/https/manual>` with your own TLS key and
|
[manually](#howto-admin-https-manual) with your own TLS key and
|
||||||
certificate. Unless you have a strong reason to use the manual method,
|
certificate. Unless you have a strong reason to use the manual method,
|
||||||
you should use the {ref}`Let's Encrypt <howto/admin/https/letsencrypt>`
|
you should use the [Let's Encrypt](#howto-admin-https-letsencrypt)
|
||||||
method.
|
method.
|
||||||
|
|
||||||
:::{note}
|
:::{note}
|
||||||
@@ -35,7 +35,7 @@ similar to this:
|
|||||||
If the machine you are running on is not reachable from the internet -
|
If the machine you are running on is not reachable from the internet -
|
||||||
for example, if it is a machine internal to your organization that
|
for example, if it is a machine internal to your organization that
|
||||||
is cut off from the internet - you can not use this method. Please
|
is cut off from the internet - you can not use this method. Please
|
||||||
set up a DNS entry and HTTPS {ref}`manually <howto/admin/https/manual>`.
|
set up a DNS entry and HTTPS [manually](#howto-admin-https-manual).
|
||||||
:::
|
:::
|
||||||
|
|
||||||
To enable HTTPS via letsencrypt:
|
To enable HTTPS via letsencrypt:
|
||||||
@@ -115,4 +115,4 @@ and now access your Hub securely at <https://yourhub.yourdomain.edu>.
|
|||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
If you're having trouble with HTTPS, looking at the {ref}`traefik proxy logs <troubleshooting/logs/traefik>` might help.
|
If you're having trouble with HTTPS, looking at the [traefik proxy logs](troubleshooting-logs-traefik) might help.
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ the cloud provider of your choice.
|
|||||||
|
|
||||||
Currently there are instructions to resize your resources on the following providers:
|
Currently there are instructions to resize your resources on the following providers:
|
||||||
|
|
||||||
- {ref}`Digital Ocean <howto/providers/digitalocean/resize>`.
|
- [Digital Ocean](howto-providers-digitalocean-resize)
|
||||||
|
|
||||||
Once resources have been reallocated, you must tell TLJH to make use of these resources,
|
Once resources have been reallocated, you must tell TLJH to make use of these resources,
|
||||||
and verify that the resources have become available.
|
and verify that the resources have become available.
|
||||||
@@ -20,7 +20,7 @@ and verify that the resources have become available.
|
|||||||
|
|
||||||
1. Once you have resized your server, tell the JupyterHub to make use of
|
1. Once you have resized your server, tell the JupyterHub to make use of
|
||||||
these new resources. To accomplish this, follow the instructions in
|
these new resources. To accomplish this, follow the instructions in
|
||||||
{ref}`topic/tljh-config` to set new memory or CPU limits and reload the hub. This can be completed
|
[](/topic/tljh-config) to set new memory or CPU limits and reload the hub. This can be completed
|
||||||
using the terminal in the JupyterHub (or via SSH-ing into your VM and using this terminal).
|
using the terminal in the JupyterHub (or via SSH-ing into your VM and using this terminal).
|
||||||
|
|
||||||
2. TLJH configuration options can be verified by viewing the tljh-config output.
|
2. TLJH configuration options can be verified by viewing the tljh-config output.
|
||||||
|
|||||||
@@ -36,7 +36,7 @@ over time. We generally recommend between 40-60% of your total class size to sta
|
|||||||
|
|
||||||
Depending on what kind of work your users are doing, they will use different amounts
|
Depending on what kind of work your users are doing, they will use different amounts
|
||||||
of memory. The easiest way to determine this is to run through a typical user
|
of memory. The easiest way to determine this is to run through a typical user
|
||||||
workflow yourself, and measure how much memory is used. You can use {ref}`howto/admin/nbresuse`
|
workflow yourself, and measure how much memory is used. You can use [](/howto/admin/nbresuse)
|
||||||
to determine how much memory your user is using.
|
to determine how much memory your user is using.
|
||||||
|
|
||||||
A good rule of thumb is to take the maximum amount of memory you used during
|
A good rule of thumb is to take the maximum amount of memory you used during
|
||||||
|
|||||||
@@ -102,7 +102,7 @@ c.GenericOAuthenticator.userdata_method = "POST"
|
|||||||
```
|
```
|
||||||
|
|
||||||
We'll use the `tljh-config` tool to configure your JupyterHub's authentication.
|
We'll use the `tljh-config` tool to configure your JupyterHub's authentication.
|
||||||
For more information on `tljh-config`, see {ref}`topic/tljh-config`.
|
For more information on `tljh-config`, see [](/topic/tljh-config).
|
||||||
|
|
||||||
1. Tell your JupyterHub to use the GenericOAuthenticator for authentication:
|
1. Tell your JupyterHub to use the GenericOAuthenticator for authentication:
|
||||||
|
|
||||||
@@ -125,4 +125,4 @@ For more information on `tljh-config`, see {ref}`topic/tljh-config`.
|
|||||||
4. You will likely have to create a new user (sign up) and then you should be directed to the
|
4. You will likely have to create a new user (sign up) and then you should be directed to the
|
||||||
Jupyter interface used in this JupyterHub.
|
Jupyter interface used in this JupyterHub.
|
||||||
5. **If this does not work** you can revert back to the default
|
5. **If this does not work** you can revert back to the default
|
||||||
JupyterHub authenticator by following the steps in {ref}`howto/auth/firstuse`.
|
JupyterHub authenticator by following the steps in [](/howto/auth/firstuse).
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ with the new IP address.
|
|||||||
## Configure your JupyterHub to use the GitHub Oauthenticator
|
## Configure your JupyterHub to use the GitHub Oauthenticator
|
||||||
|
|
||||||
We'll use the `tljh-config` tool to configure your JupyterHub's authentication.
|
We'll use the `tljh-config` tool to configure your JupyterHub's authentication.
|
||||||
For more information on `tljh-config`, see {ref}`topic/tljh-config`.
|
For more information on `tljh-config`, see [](/topic/tljh-config).
|
||||||
|
|
||||||
1. Log in as an administrator account to your JupyterHub.
|
1. Log in as an administrator account to your JupyterHub.
|
||||||
|
|
||||||
@@ -105,4 +105,4 @@ For more information on `tljh-config`, see {ref}`topic/tljh-config`.
|
|||||||
Jupyter interface used in this JupyterHub.
|
Jupyter interface used in this JupyterHub.
|
||||||
|
|
||||||
5. **If this does not work** you can revert back to the default
|
5. **If this does not work** you can revert back to the default
|
||||||
JupyterHub authenticator by following the steps in {ref}`howto/auth/firstuse`.
|
JupyterHub authenticator by following the steps in [](/howto/auth/firstuse).
|
||||||
|
|||||||
@@ -77,7 +77,7 @@ with the new IP address.
|
|||||||
## Configure your JupyterHub to use the Google Oauthenticator
|
## Configure your JupyterHub to use the Google Oauthenticator
|
||||||
|
|
||||||
We'll use the `tljh-config` tool to configure your JupyterHub's authentication.
|
We'll use the `tljh-config` tool to configure your JupyterHub's authentication.
|
||||||
For more information on `tljh-config`, see {ref}`topic/tljh-config`.
|
For more information on `tljh-config`, see [](/topic/tljh-config).
|
||||||
|
|
||||||
1. Log in as an administrator account to your JupyterHub.
|
1. Log in as an administrator account to your JupyterHub.
|
||||||
|
|
||||||
@@ -130,4 +130,4 @@ For more information on `tljh-config`, see {ref}`topic/tljh-config`.
|
|||||||
Jupyter interface used in this JupyterHub.
|
Jupyter interface used in this JupyterHub.
|
||||||
|
|
||||||
5. **If this does not work** you can revert back to the default
|
5. **If this does not work** you can revert back to the default
|
||||||
JupyterHub authenticator by following the steps in {ref}`howto/auth/firstuse`.
|
JupyterHub authenticator by following the steps in [](/howto/auth/firstuse).
|
||||||
|
|||||||
@@ -4,13 +4,13 @@
|
|||||||
|
|
||||||
This section covers how to add data to your JupyterHub either from the internet
|
This section covers how to add data to your JupyterHub either from the internet
|
||||||
or from your own machine. To learn how to **share data** that is already
|
or from your own machine. To learn how to **share data** that is already
|
||||||
on your JupyterHub, see {ref}`howto/content/share-data`.
|
on your JupyterHub, see [](/howto/content/share-data).
|
||||||
|
|
||||||
:::{note}
|
:::{note}
|
||||||
When you add data using the methods on this page, you will **only add it
|
When you add data using the methods on this page, you will **only add it
|
||||||
to your user directory**. This is not a place that is accessible to others.
|
to your user directory**. This is not a place that is accessible to others.
|
||||||
For information on sharing this data with users on the JupyterHub, see
|
For information on sharing this data with users on the JupyterHub, see
|
||||||
{ref}`howto/content/share-data`.
|
[](/howto/content/share-data).
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Adding data from your local machine
|
## Adding data from your local machine
|
||||||
@@ -40,7 +40,7 @@ interface. To do so, follow these steps:
|
|||||||
be on your JupyterHub, your home user's home directory.
|
be on your JupyterHub, your home user's home directory.
|
||||||
|
|
||||||
To learn how to **share** this data with new users on the JupyterHub,
|
To learn how to **share** this data with new users on the JupyterHub,
|
||||||
see {ref}`howto/content/share-data`.
|
see [](/howto/content/share-data).
|
||||||
|
|
||||||
## Downloading data from the command line
|
## Downloading data from the command line
|
||||||
|
|
||||||
@@ -95,6 +95,6 @@ time. You can download it from your browser [at this link](https://swcarpentry.g
|
|||||||
5. Confirm that your data was unzipped. It could be in a folder called `data/`.
|
5. Confirm that your data was unzipped. It could be in a folder called `data/`.
|
||||||
|
|
||||||
To learn how to **share** this data with new users on the JupyterHub,
|
To learn how to **share** this data with new users on the JupyterHub,
|
||||||
see {ref}`howto/content/share-data`.
|
see [](/howto/content/share-data).
|
||||||
|
|
||||||
% TODO: Downloading data with the "download" module in Python? https://github.com/choldgraf/download
|
% TODO: Downloading data with the "download" module in Python? https://github.com/choldgraf/download
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ contained in the link's target repository is downloaded to the user's home
|
|||||||
directory. Note that a copy of the dataset will be made for each user.
|
directory. Note that a copy of the dataset will be made for each user.
|
||||||
|
|
||||||
For information on creating and sharing `nbgitpuller` links, see
|
For information on creating and sharing `nbgitpuller` links, see
|
||||||
{ref}`howto/content/nbgitpuller`.
|
[](/howto/content/nbgitpuller).
|
||||||
|
|
||||||
## Option 2: Create a read-only shared folder for data
|
## Option 2: Create a read-only shared folder for data
|
||||||
|
|
||||||
@@ -37,7 +37,7 @@ steps:
|
|||||||
sudo mkdir -p /srv/data/my_shared_data_folder
|
sudo mkdir -p /srv/data/my_shared_data_folder
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Download the data** into this folder. See {ref}`howto/content/add-data` for
|
4. **Download the data** into this folder. See [](/howto/content/add-data) for
|
||||||
details on how to do this.
|
details on how to do this.
|
||||||
|
|
||||||
5. All users now have read access to the data in this folder.
|
5. All users now have read access to the data in this folder.
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ env/server-resources
|
|||||||
|
|
||||||
We have a special set of How-To Guides on using various forms of authentication
|
We have a special set of How-To Guides on using various forms of authentication
|
||||||
with your JupyterHub. For more information on Authentication, see
|
with your JupyterHub. For more information on Authentication, see
|
||||||
{ref}`topic/authenticator-configuration`
|
[](/topic/authenticator-configuration)
|
||||||
|
|
||||||
```{toctree}
|
```{toctree}
|
||||||
:titlesonly: true
|
:titlesonly: true
|
||||||
|
|||||||
@@ -39,4 +39,4 @@ disk space, or CPUs. Digital Ocean servers can be resized in the
|
|||||||
|
|
||||||
Now that you've resized your Droplet, you may want to change the resources available
|
Now that you've resized your Droplet, you may want to change the resources available
|
||||||
to your users. Further information on making more resources available to
|
to your users. Further information on making more resources available to
|
||||||
users and verifying resource availability can be found in {ref}`howto/admin/resize`.
|
users and verifying resource availability can be found in [](/howto/admin/resize).
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
A simple [JupyterHub](https://github.com/jupyterhub/jupyterhub) distribution for
|
A simple [JupyterHub](https://github.com/jupyterhub/jupyterhub) distribution for
|
||||||
a small (0-100) number of users on a single server. We recommend reading
|
a small (0-100) number of users on a single server. We recommend reading
|
||||||
{ref}`topic/whentouse` to determine if this is the right tool for you.
|
[](/topic/whentouse) to determine if this is the right tool for you.
|
||||||
|
|
||||||
## Development Status
|
## Development Status
|
||||||
|
|
||||||
|
|||||||
@@ -27,4 +27,4 @@ The packages ``gdal`` and ``there`` are now available to all users in JupyterHub
|
|||||||
If a user already had a python notebook running, they have to restart their notebook's
|
If a user already had a python notebook running, they have to restart their notebook's
|
||||||
kernel to make the new libraries available.
|
kernel to make the new libraries available.
|
||||||
|
|
||||||
See :ref:`howto/env/user_environment` for more information.
|
See :ref:`howto-env-user-environment` for more information.
|
||||||
|
|||||||
@@ -72,7 +72,7 @@ Let's create the server on which we can run JupyterHub.
|
|||||||
offers. Select the one you want and then select the button
|
offers. Select the one you want and then select the button
|
||||||
`Next: Configure Instance Details` in the lower right corner.
|
`Next: Configure Instance Details` in the lower right corner.
|
||||||
|
|
||||||
Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick
|
Check out our guide on How To [](/howto/admin/resource-estimation) to help pick
|
||||||
how much Memory / CPU your server needs.
|
how much Memory / CPU your server needs.
|
||||||
We recommend you use a server with at least 2GB of RAM, such as a **t3.small**.
|
We recommend you use a server with at least 2GB of RAM, such as a **t3.small**.
|
||||||
However, if you need to minimise costs you can use a server with **1GB** RAM such as a **t2.micro**, but performance will be limited.
|
However, if you need to minimise costs you can use a server with **1GB** RAM such as a **t2.micro**, but performance will be limited.
|
||||||
@@ -101,8 +101,8 @@ Let's create the server on which we can run JupyterHub.
|
|||||||
```
|
```
|
||||||
|
|
||||||
:::{note}
|
:::{note}
|
||||||
See {ref}`topic/installer-actions` for a detailed description and
|
See [](/topic/installer-actions) for a detailed description and
|
||||||
{ref}`topic/customizing-installer` for other options that can be used.
|
[](/topic/customizing-installer) for other options that can be used.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
8. Under **Step 4: Add Storage**, you can change the **size** and **type of your
|
8. Under **Step 4: Add Storage**, you can change the **size** and **type of your
|
||||||
@@ -112,7 +112,7 @@ Let's create the server on which we can run JupyterHub.
|
|||||||
:alt: Selecting disk size and type
|
:alt: Selecting disk size and type
|
||||||
```
|
```
|
||||||
|
|
||||||
Check out {ref}`howto/admin/resource-estimation` to help pick
|
Check out [](/howto/admin/resource-estimation) to help pick
|
||||||
how much Disk space your server needs.
|
how much Disk space your server needs.
|
||||||
|
|
||||||
Hover over the encircled `i` next to **Volume Type** for an explanation of
|
Hover over the encircled `i` next to **Volume Type** for an explanation of
|
||||||
|
|||||||
@@ -161,8 +161,8 @@ A new screen with all the options for Virtual Machines in Azure will displayed.
|
|||||||
```
|
```
|
||||||
|
|
||||||
:::{note}
|
:::{note}
|
||||||
See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing.
|
See [](/topic/installer-actions) if you want to understand exactly what the installer is doing.
|
||||||
{ref}`topic/customizing-installer` documents other options that can be passed to the installer.
|
[](/topic/customizing-installer) documents other options that can be passed to the installer.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
8. Check the summary and confirm the creation of your Virtual Machine.
|
8. Check the summary and confirm the creation of your Virtual Machine.
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ on your personal computer.
|
|||||||
:::{note}
|
:::{note}
|
||||||
Running TLJH _inside_ a docker container is not supported, since we depend
|
Running TLJH _inside_ a docker container is not supported, since we depend
|
||||||
on systemd. If you want to run TLJH locally for development, see
|
on systemd. If you want to run TLJH locally for development, see
|
||||||
{ref}`contributing/dev-setup`.
|
[](/contributing/dev-setup).
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Goal
|
## Goal
|
||||||
@@ -31,7 +31,7 @@ a server you have access to.
|
|||||||
4. Ability to `ssh` into the server & run commands from the prompt.
|
4. Ability to `ssh` into the server & run commands from the prompt.
|
||||||
5. An **IP address** where the server can be reached from the browsers of your target audience.
|
5. An **IP address** where the server can be reached from the browsers of your target audience.
|
||||||
|
|
||||||
If you run into issues, look at the specific {ref}`troubleshooting guide <troubleshooting/providers/custom>`
|
If you run into issues, look at the specific [troubleshooting guide](/troubleshooting/providers/custom)
|
||||||
for custom server installations.
|
for custom server installations.
|
||||||
|
|
||||||
## Step 1: Installing The Littlest JupyterHub
|
## Step 1: Installing The Littlest JupyterHub
|
||||||
@@ -56,8 +56,8 @@ for custom server installations.
|
|||||||
```
|
```
|
||||||
|
|
||||||
:::{note}
|
:::{note}
|
||||||
See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing.
|
See [](/topic/installer-actions) if you want to understand exactly what the installer is doing.
|
||||||
{ref}`topic/customizing-installer` documents other options that can be passed to the installer.
|
[](/topic/customizing-installer) documents other options that can be passed to the installer.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
4. Press `Enter` to start the installation process. This will take 5-10 minutes,
|
4. Press `Enter` to start the installation process. This will take 5-10 minutes,
|
||||||
@@ -92,4 +92,4 @@ for custom server installations.
|
|||||||
## Step 4: Setup HTTPS
|
## Step 4: Setup HTTPS
|
||||||
|
|
||||||
Once you are ready to run your server for real, and have a domain, it's a good
|
Once you are ready to run your server for real, and have a domain, it's a good
|
||||||
idea to proceed directly to {ref}`howto/admin/https`.
|
idea to proceed directly to [](/howto/admin/https).
|
||||||
|
|||||||
@@ -40,7 +40,7 @@ Let's create the server on which we can run JupyterHub.
|
|||||||
(4GB RAM, 2CPUs, 20 USD / month) is not a bad start. You can resize your server
|
(4GB RAM, 2CPUs, 20 USD / month) is not a bad start. You can resize your server
|
||||||
later if you need.
|
later if you need.
|
||||||
|
|
||||||
Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick
|
Check out our guide on How To [](/howto/admin/resource-estimation) to help pick
|
||||||
how much Memory, CPU & disk space your server needs.
|
how much Memory, CPU & disk space your server needs.
|
||||||
|
|
||||||
5. Scroll down to **Select additional options**, and select **User data**.
|
5. Scroll down to **Select additional options**, and select **User data**.
|
||||||
@@ -66,8 +66,8 @@ Let's create the server on which we can run JupyterHub.
|
|||||||
```
|
```
|
||||||
|
|
||||||
:::{note}
|
:::{note}
|
||||||
See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing.
|
See [](/topic/installer-actions) if you want to understand exactly what the installer is doing.
|
||||||
{ref}`topic/customizing-installer` documents other options that can be passed to the installer.
|
[](/topic/customizing-installer) documents other options that can be passed to the installer.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
7. Under the **Finalize and create** section, enter a `hostname` that descriptively
|
7. Under the **Finalize and create** section, enter a `hostname` that descriptively
|
||||||
|
|||||||
@@ -84,7 +84,7 @@ Let's create the server on which we can run JupyterHub.
|
|||||||
:alt: Select a customized VM size
|
:alt: Select a customized VM size
|
||||||
```
|
```
|
||||||
|
|
||||||
Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick
|
Check out our guide on How To [](/howto/admin/resource-estimation) to help pick
|
||||||
how much Memory / CPU your server needs.
|
how much Memory / CPU your server needs.
|
||||||
|
|
||||||
11. Under **Boot Disk**, click the **Change** button. This lets us change the
|
11. Under **Boot Disk**, click the **Change** button. This lets us change the
|
||||||
@@ -113,7 +113,7 @@ Let's create the server on which we can run JupyterHub.
|
|||||||
to a hard drive. **SSD persistent disk** gives you a faster but more expensive
|
to a hard drive. **SSD persistent disk** gives you a faster but more expensive
|
||||||
disk, similar to an SSD.
|
disk, similar to an SSD.
|
||||||
|
|
||||||
Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick
|
Check out our guide on How To [](/howto/admin/resource-estimation) to help pick
|
||||||
how much Disk space your server needs.
|
how much Disk space your server needs.
|
||||||
|
|
||||||
14. Click the **Select** button to dismiss the Boot disk popup and go back to the
|
14. Click the **Select** button to dismiss the Boot disk popup and go back to the
|
||||||
@@ -160,8 +160,8 @@ Let's create the server on which we can run JupyterHub.
|
|||||||
```
|
```
|
||||||
|
|
||||||
:::{note}
|
:::{note}
|
||||||
See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing.
|
See [](/topic/installer-actions) if you want to understand exactly what the installer is doing.
|
||||||
{ref}`topic/customizing-installer` documents other options that can be passed to the installer.
|
[](/topic/customizing-installer) documents other options that can be passed to the installer.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
19. Click the **Create** button at the bottom to start your server!
|
19. Click the **Create** button at the bottom to start your server!
|
||||||
|
|||||||
@@ -55,7 +55,7 @@ Let's create the server on which we can run JupyterHub.
|
|||||||
2. Select an appropriate **Instance Size**. We suggest m1.medium or larger.
|
2. Select an appropriate **Instance Size**. We suggest m1.medium or larger.
|
||||||
Make sure your instance has at least **1GB** of RAM.
|
Make sure your instance has at least **1GB** of RAM.
|
||||||
|
|
||||||
Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick
|
Check out our guide on How To [](/howto/admin/resource-estimation) to help pick
|
||||||
how much Memory, CPU & disk space your server needs.
|
how much Memory, CPU & disk space your server needs.
|
||||||
|
|
||||||
3. If you have multiple allocations, make sure you are 'charging' this server
|
3. If you have multiple allocations, make sure you are 'charging' this server
|
||||||
@@ -93,8 +93,8 @@ Let's create the server on which we can run JupyterHub.
|
|||||||
```
|
```
|
||||||
|
|
||||||
:::{note}
|
:::{note}
|
||||||
See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing.
|
See [](/topic/installer-actions) if you want to understand exactly what the installer is doing.
|
||||||
{ref}`topic/customizing-installer` documents other options that can be passed to the installer.
|
[](/topic/customizing-installer) documents other options that can be passed to the installer.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
9. Under **Execution Strategy Type**, select **Run script on first boot**.
|
9. Under **Execution Strategy Type**, select **Run script on first boot**.
|
||||||
|
|||||||
@@ -77,8 +77,8 @@ Let's create the server on which we can run JupyterHub.
|
|||||||
```
|
```
|
||||||
|
|
||||||
:::{note}
|
:::{note}
|
||||||
See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing.
|
See [](/topic/installer-actions) if you want to understand exactly what the installer is doing.
|
||||||
{ref}`topic/customizing-installer` documents other options that can be passed to the installer.
|
[](/topic/customizing-installer) documents other options that can be passed to the installer.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
```{image} ../images/providers/ovh/configuration.png
|
```{image} ../images/providers/ovh/configuration.png
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ can be used with TLJH. A number of them ship by default with TLJH:
|
|||||||
OAuth based authentication methods.
|
OAuth based authentication methods.
|
||||||
2. [LDAPAuthenticator](https://github.com/jupyterhub/ldapauthenticator) - LDAP & Active Directory.
|
2. [LDAPAuthenticator](https://github.com/jupyterhub/ldapauthenticator) - LDAP & Active Directory.
|
||||||
3. [DummyAuthenticator](https://github.com/yuvipanda/jupyterhub-dummy-authenticator) - Any username,
|
3. [DummyAuthenticator](https://github.com/yuvipanda/jupyterhub-dummy-authenticator) - Any username,
|
||||||
one shared password. A {ref}`how-to guide on using DummyAuthenticator <howto/auth/dummy>` is also
|
one shared password. A [how-to guide on using DummyAuthenticator](howto-auth-dummy) is also
|
||||||
available.
|
available.
|
||||||
4. [FirstUseAuthenticator](https://github.com/yuvipanda/jupyterhub-firstuseauthenticator) - Users set
|
4. [FirstUseAuthenticator](https://github.com/yuvipanda/jupyterhub-firstuseauthenticator) - Users set
|
||||||
their password when they log in for the first time. Default authenticator used in TLJH.
|
their password when they log in for the first time. Default authenticator used in TLJH.
|
||||||
@@ -75,7 +75,7 @@ sudo tljh-config reload
|
|||||||
|
|
||||||
Try logging in a separate incognito window to check if your configuration works. This
|
Try logging in a separate incognito window to check if your configuration works. This
|
||||||
lets you preserve your terminal in case there were errors. If there are
|
lets you preserve your terminal in case there were errors. If there are
|
||||||
errors, {ref}`troubleshooting/logs` should help you debug them.
|
errors, [](/troubleshooting/logs) should help you debug them.
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
|
|||||||
@@ -110,7 +110,7 @@ The Littlest JupyterHub can install additional _plugins_ that provide additional
|
|||||||
features. They are most commonly used to install a particular _stack_ - such as
|
features. They are most commonly used to install a particular _stack_ - such as
|
||||||
the [PANGEO Stack](https://github.com/yuvipanda/tljh-pangeo) for earth sciences
|
the [PANGEO Stack](https://github.com/yuvipanda/tljh-pangeo) for earth sciences
|
||||||
research, a stack for a particular class, etc. You can find more information about
|
research, a stack for a particular class, etc. You can find more information about
|
||||||
writing plugins and a list of existing plugins at {ref}`contributing/plugins`.
|
writing plugins and a list of existing plugins at [](/contributing/plugins).
|
||||||
|
|
||||||
`--plugin <plugin-to-install>` installs and activates a plugin. You can pass it
|
`--plugin <plugin-to-install>` installs and activates a plugin. You can pass it
|
||||||
however many times you want. Since plugins are distributed as python packages,
|
however many times you want. Since plugins are distributed as python packages,
|
||||||
|
|||||||
@@ -20,4 +20,4 @@ about how to get HTTP traffic from the world into your server.
|
|||||||
|
|
||||||
## CPU / Memory / Disk Space
|
## CPU / Memory / Disk Space
|
||||||
|
|
||||||
See how to {ref}`howto/admin/resource-estimation`
|
See how to [](/howto/admin/resource-estimation)
|
||||||
|
|||||||
@@ -66,4 +66,4 @@ feature of systemd.
|
|||||||
## HTTPS
|
## HTTPS
|
||||||
|
|
||||||
Any internet-facing JupyterHub should use HTTPS to secure its traffic. For
|
Any internet-facing JupyterHub should use HTTPS to secure its traffic. For
|
||||||
information on how to use HTTPS with your JupyterHub, see {ref}`howto/admin/https`.
|
information on how to use HTTPS with your JupyterHub, see [](/howto/admin/https).
|
||||||
|
|||||||
@@ -37,7 +37,7 @@ logs is a great first step.
|
|||||||
sudo journalctl -u jupyterhub
|
sudo journalctl -u jupyterhub
|
||||||
```
|
```
|
||||||
|
|
||||||
This command displays logs from JupyterHub itself. See {ref}`journalctl_tips`
|
This command displays logs from JupyterHub itself. See [](#journalctl-tips)
|
||||||
for tips on navigating the logs.
|
for tips on navigating the logs.
|
||||||
|
|
||||||
(troubleshooting-logs-traefik)=
|
(troubleshooting-logs-traefik)=
|
||||||
@@ -52,7 +52,7 @@ is one line cryptic error messages, or if you are having trouble with HTTPS.
|
|||||||
sudo journalctl -u traefik
|
sudo journalctl -u traefik
|
||||||
```
|
```
|
||||||
|
|
||||||
This command displays logs from Traefik. See {ref}`journalctl_tips`
|
This command displays logs from Traefik. See [](#journalctl-tips)
|
||||||
for tips on navigating the logs.
|
for tips on navigating the logs.
|
||||||
|
|
||||||
## User Server Logs
|
## User Server Logs
|
||||||
@@ -67,7 +67,7 @@ sudo journalctl -u jupyter-<name-of-user>
|
|||||||
|
|
||||||
This command displays logs from the given user's notebook server. You can get a
|
This command displays logs from the given user's notebook server. You can get a
|
||||||
list of all users from the "users" button at the top-right of the Admin page.
|
list of all users from the "users" button at the top-right of the Admin page.
|
||||||
See {ref}`journalctl_tips` for tips on navigating the logs.
|
See [](#journalctl-tips) for tips on navigating the logs.
|
||||||
|
|
||||||
(journalctl-tips)=
|
(journalctl-tips)=
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user