Correct links

This commit is contained in:
Carol Willing
2017-08-09 13:51:19 -07:00
parent dd1902b1d9
commit 68e02dd62a
9 changed files with 20 additions and 24 deletions

View File

@@ -8,7 +8,7 @@ The JupyterHub API
:Date: |today| :Date: |today|
JupyterHub also provides a REST API for administration of the Hub and users. JupyterHub also provides a REST API for administration of the Hub and users.
The documentation on `Using JupyterHub's REST API <../rest.html>`_ provides The documentation on `Using JupyterHub's REST API <../reference/rest.html>`_ provides
information on: information on:
- what you can do with the API - what you can do with the API

View File

@@ -1,4 +1,4 @@
# Authentication and Users # Authentication and User Basics
The default Authenticator uses [PAM][] to authenticate system users with The default Authenticator uses [PAM][] to authenticate system users with
their username and password. With the default Authenticator, any user their username and password. With the default Authenticator, any user

View File

@@ -1,8 +1,8 @@
# Configuration Basics # Configuration Basics
The section contains basic information about configuring settings for a JupyterHub The section contains basic information about configuring settings for a JupyterHub
deployment. The [configuration reference](./configuration-guide.html) deployment. The [Technical Reference](../reference/index.html)
provides additional detail. documentation provides additional details.
This section will help you learn how to: This section will help you learn how to:
@@ -80,7 +80,7 @@ The default authentication and process spawning mechanisms can be replaced, and
specific [authenticators](./authenticators-users-basics.html) and specific [authenticators](./authenticators-users-basics.html) and
[spawners](./spawners-basics.html) can be set in the configuration file. [spawners](./spawners-basics.html) can be set in the configuration file.
This enables JupyterHub to be used with a variety of authentication methods or This enables JupyterHub to be used with a variety of authentication methods or
process control and deployment environments. [Some examples](./config-examples.html), process control and deployment environments. [Some examples](../reference/config-examples.html),
meant as illustration, are: meant as illustration, are:
- Using GitHub OAuth instead of PAM with [OAuthenticator](https://github.com/jupyterhub/oauthenticator) - Using GitHub OAuth instead of PAM with [OAuthenticator](https://github.com/jupyterhub/oauthenticator)

View File

@@ -29,14 +29,14 @@ Hub via the REST API.
To run such an external service, an API token must be created and To run such an external service, an API token must be created and
provided to the service. provided to the service.
As of [version 0.6.0](./changelog.html), the preferred way of As of [version 0.6.0](../changelog.html), the preferred way of doing
generating an API token is: this is to first generate an API token:
```bash ```bash
openssl rand -hex 32 openssl rand -hex 32
``` ```
In [version 0.8.0](./changelog.html), a TOKEN request page for In [version 0.8.0](../changelog.html), a TOKEN request page for
generating an API token is available from the JupyterHub user interface: generating an API token is available from the JupyterHub user interface:
![Request API TOKEN page](images/api-token-request.png) ![Request API TOKEN page](images/api-token-request.png)
@@ -116,6 +116,4 @@ variable. Run `cull_idle_servers.py` manually.
python cull_idle_servers.py [--timeout=900] [--url=http://127.0.0.1:8081/hub/api] python cull_idle_servers.py [--timeout=900] [--url=http://127.0.0.1:8081/hub/api]
``` ```
[cull_idle_servers]: https://github.com/jupyterhub/jupyterhub/blob/master/examples/cull-idle/cull_idle_servers.py [cull_idle_servers]: https://github.com/jupyterhub/jupyterhub/blob/master/examples/cull-idle/cull_idle_servers.py

View File

@@ -207,5 +207,5 @@ server {
``` ```
Now just restart `nginx`, restart the JupyterHub, and enjoy accessing Now just restart `nginx`, restart the JupyterHub, and enjoy accessing
https://HUB.DOMAIN.TLD while serving other content securely on `https://HUB.DOMAIN.TLD` while serving other content securely on
https://NO_HUB.DOMAIN.TLD. `https://NO_HUB.DOMAIN.TLD`.

View File

@@ -27,7 +27,7 @@ Hub.
To send requests using JupyterHub API, you must pass an API token with To send requests using JupyterHub API, you must pass an API token with
the request. the request.
As of [version 0.6.0](./changelog.html), the preferred way of As of [version 0.6.0](../changelog.html), the preferred way of
generating an API token is: generating an API token is:
```bash ```bash
@@ -38,7 +38,6 @@ This `openssl` command generates a potential token that can then be
added to JupyterHub using `.api_tokens` configuration setting in added to JupyterHub using `.api_tokens` configuration setting in
`jupyterhub_config.py`. `jupyterhub_config.py`.
Alternatively, use the `jupyterhub token` command to generate a token Alternatively, use the `jupyterhub token` command to generate a token
for a specific hub user by passing the 'username': for a specific hub user by passing the 'username':
@@ -49,12 +48,11 @@ jupyterhub token <username>
This command generates a random string to use as a token and registers This command generates a random string to use as a token and registers
it for the given user with the Hub's database. it for the given user with the Hub's database.
In [version 0.8.0](./changelog.html), a TOKEN request page for In [version 0.8.0](../changelog.html), a TOKEN request page for
generating an API token is available from the JupyterHub user interface: generating an API token is available from the JupyterHub user interface:
![Request API TOKEN page](images/api-token-request.png) ![Request API TOKEN page](images/api-token-request.png)
## Add API tokens to the config file ## Add API tokens to the config file
You may also add a dictionary of API tokens and usernames to the hub's You may also add a dictionary of API tokens and usernames to the hub's
@@ -128,5 +126,5 @@ Note: The Swagger specification is being renamed the [OpenAPI Initiative][].
[interactive style on swagger's petstore]: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyterhub/jupyterhub/master/docs/rest-api.yml#!/default [interactive style on swagger's petstore]: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyterhub/jupyterhub/master/docs/rest-api.yml#!/default
[OpenAPI Initiative]: https://www.openapis.org/ [OpenAPI Initiative]: https://www.openapis.org/
[JupyterHub REST API]: ./_static/rest-api/index.html [JupyterHub REST API]: ../_static/rest-api/index.html
[Jupyter Notebook REST API]: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml [Jupyter Notebook REST API]: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml

View File

@@ -355,7 +355,7 @@ section on securing the notebook viewer.
[requests]: http://docs.python-requests.org/en/master/ [requests]: http://docs.python-requests.org/en/master/
[services_auth]: api/services.auth.html [services_auth]: ../api/services.auth.html
[HubAuth]: api/services.auth.html#jupyterhub.services.auth.HubAuth [HubAuth]: ../api/services.auth.html#jupyterhub.services.auth.HubAuth
[HubAuthenticated]: api/services.auth.html#jupyterhub.services.auth.HubAuthenticated [HubAuthenticated]: ../api/services.auth.html#jupyterhub.services.auth.HubAuthenticated
[nbviewer example]: https://github.com/jupyter/nbviewer#securing-the-notebook-viewer [nbviewer example]: https://github.com/jupyter/nbviewer#securing-the-notebook-viewer

View File

@@ -111,7 +111,7 @@ working directory:
This file needs to persist so that a **Hub** server restart will avoid This file needs to persist so that a **Hub** server restart will avoid
invalidating cookies. Conversely, deleting this file and restarting the server invalidating cookies. Conversely, deleting this file and restarting the server
effectively invalidates all login cookies. The cookie secret file is discussed effectively invalidates all login cookies. The cookie secret file is discussed
in the [Cookie Secret section of the Security Settings document](./security-basics.html). in the [Cookie Secret section of the Security Settings document](../getting-started/security-basics.html).
The location of these files can be specified via configuration settings. It is The location of these files can be specified via configuration settings. It is
recommended that these files be stored in standard UNIX filesystem locations, recommended that these files be stored in standard UNIX filesystem locations,

View File

@@ -1,7 +1,7 @@
Tutorials Tutorials
========= =========
This section provides links to documentation that helps a user do a specific
task.
How do I? - [Zero to JupyterHub with Kubernetes](https://zero-to-jupyterhub.readthedocs.io/en/latest/)
Zero to JupyterHub