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:
@@ -17,7 +17,7 @@ so attackers can not easily gain control of the system.
|
||||
:::{important}
|
||||
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
|
||||
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
|
||||
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
|
||||
securely. The Littlest JupyterHub supports automatically configuring HTTPS
|
||||
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,
|
||||
you should use the {ref}`Let's Encrypt <howto/admin/https/letsencrypt>`
|
||||
you should use the [Let's Encrypt](#howto-admin-https-letsencrypt)
|
||||
method.
|
||||
|
||||
:::{note}
|
||||
@@ -35,7 +35,7 @@ similar to this:
|
||||
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
|
||||
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:
|
||||
@@ -115,4 +115,4 @@ and now access your Hub securely at <https://yourhub.yourdomain.edu>.
|
||||
|
||||
## 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:
|
||||
|
||||
- {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,
|
||||
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
|
||||
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).
|
||||
|
||||
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
|
||||
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.
|
||||
|
||||
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.
|
||||
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:
|
||||
|
||||
@@ -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
|
||||
Jupyter interface used in this JupyterHub.
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
@@ -105,4 +105,4 @@ For more information on `tljh-config`, see {ref}`topic/tljh-config`.
|
||||
Jupyter interface used in this JupyterHub.
|
||||
|
||||
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
|
||||
|
||||
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.
|
||||
|
||||
@@ -130,4 +130,4 @@ For more information on `tljh-config`, see {ref}`topic/tljh-config`.
|
||||
Jupyter interface used in this JupyterHub.
|
||||
|
||||
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
|
||||
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}
|
||||
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.
|
||||
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
|
||||
@@ -40,7 +40,7 @@ interface. To do so, follow these steps:
|
||||
be on your JupyterHub, your home user's home directory.
|
||||
|
||||
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
|
||||
|
||||
@@ -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/`.
|
||||
|
||||
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
|
||||
|
||||
@@ -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.
|
||||
|
||||
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
|
||||
|
||||
@@ -37,7 +37,7 @@ steps:
|
||||
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.
|
||||
|
||||
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
|
||||
with your JupyterHub. For more information on Authentication, see
|
||||
{ref}`topic/authenticator-configuration`
|
||||
[](/topic/authenticator-configuration)
|
||||
|
||||
```{toctree}
|
||||
: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
|
||||
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).
|
||||
|
||||
Reference in New Issue
Block a user