mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-18 07:23:00 +00:00
fix link targets after rst2myst
This commit is contained in:
@@ -1,14 +1,14 @@
|
||||
---
|
||||
Date: "{{ today }}"
|
||||
Release: "{{ release }}"
|
||||
---
|
||||
|
||||
(api-index)=
|
||||
|
||||
# JupyterHub API
|
||||
|
||||
```{eval-rst}
|
||||
:Date: |today|
|
||||
:Release: |release|
|
||||
```
|
||||
|
||||
JupyterHub also provides a REST API for administration of the Hub and users.
|
||||
The documentation on [Using JupyterHub's REST API](../reference/rest.html) provides
|
||||
The documentation on [Using JupyterHub's REST API](../reference/rest.md) provides
|
||||
information on:
|
||||
|
||||
- what you can do with the API
|
||||
|
@@ -1,4 +1,4 @@
|
||||
(contributing-setup)=
|
||||
(contributing/setup)=
|
||||
|
||||
# Setting up a development install
|
||||
|
||||
|
@@ -34,7 +34,7 @@ The output is a file, `"event.log"`, with events recorded as JSON data.
|
||||
```{toctree}
|
||||
:maxdepth: 2
|
||||
|
||||
server-actions.rst
|
||||
server-actions
|
||||
```
|
||||
|
||||
[json schemas]: https://json-schema.org/
|
||||
|
@@ -11,6 +11,8 @@ This section will help you learn how to:
|
||||
- configure JupyterHub using command line options
|
||||
- find information and examples for some common deployments
|
||||
|
||||
(generate-config-file)=
|
||||
|
||||
## Generate a default config file
|
||||
|
||||
On startup, JupyterHub will look by default for a configuration file,
|
||||
|
@@ -41,7 +41,7 @@ is important that these files be put in a secure location on your server, where
|
||||
they are not readable by regular users.
|
||||
|
||||
If you are using a **chain certificate**, see also chained certificate for SSL
|
||||
in the JupyterHub [Troubleshooting FAQ](../troubleshooting.html).
|
||||
in the JupyterHub [Troubleshooting FAQ](../troubleshooting.md).
|
||||
|
||||
### Using letsencrypt
|
||||
|
||||
|
@@ -48,7 +48,7 @@ follows the Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/
|
||||
|
||||
## Contents
|
||||
|
||||
(index-distributions)=
|
||||
(index/distributions)=
|
||||
|
||||
### Distributions
|
||||
|
||||
|
@@ -2,7 +2,7 @@
|
||||
|
||||
A scope has a syntax-based design that reveals which resources it provides access to. Resources are objects with a type, associated data, relationships to other resources, and a set of methods that operate on them (see [RESTful API](https://restful-api-design.readthedocs.io/en/latest/resources.html) documentation for more information).
|
||||
|
||||
`<resource>` in the RBAC scope design refers to the resource name in the [JupyterHub's API](../reference/rest-api.rst) endpoints in most cases. For instance, `<resource>` equal to `users` corresponds to JupyterHub's API endpoints beginning with _/users_.
|
||||
`<resource>` in the RBAC scope design refers to the resource name in the [JupyterHub's API](../reference/rest-api.md) endpoints in most cases. For instance, `<resource>` equal to `users` corresponds to JupyterHub's API endpoints beginning with _/users_.
|
||||
|
||||
(scope-conventions-target)=
|
||||
|
||||
@@ -298,6 +298,6 @@ Custom scope _filters_ are NOT supported.
|
||||
|
||||
### Scopes and APIs
|
||||
|
||||
The scopes are also listed in the [](../reference/rest-api.rst) documentation. Each API endpoint has a list of scopes which can be used to access the API; if no scopes are listed, the API is not authenticated and can be accessed without any permissions (i.e., no scopes).
|
||||
The scopes are also listed in the [](../reference/rest-api.md) documentation. Each API endpoint has a list of scopes which can be used to access the API; if no scopes are listed, the API is not authenticated and can be accessed without any permissions (i.e., no scopes).
|
||||
|
||||
Listed scopes by each API endpoint reflect the "lowest" permissions required to gain any access to the corresponding API. For example, posting user's activity (_POST /users/:name/activity_) needs `users:activity` scope. If scope `users` is passed during the request, the access will be granted as the required scope is a subscope of the `users` scope. If, on the other hand, `read:users:activity` scope is passed, the access will be denied.
|
||||
|
@@ -11,7 +11,7 @@ No other database records are affected.
|
||||
## Upgrade steps
|
||||
|
||||
1. All running **servers must be stopped** before proceeding with the upgrade.
|
||||
2. To upgrade the Hub, follow the [Upgrading JupyterHub](../admin/upgrading.rst) instructions.
|
||||
2. To upgrade the Hub, follow the [Upgrading JupyterHub](../admin/upgrading.md) instructions.
|
||||
```{attention}
|
||||
We advise against defining any new roles in the `jupyterhub.config.py` file right after the upgrade is completed and JupyterHub restarted for the first time. This preserves the 'current' state of the Hub. You can define and assign new roles on any other following startup.
|
||||
```
|
||||
@@ -45,7 +45,7 @@ OAuth token is issued by the Hub to a single-user server when the user logs in.
|
||||
|
||||
API token is issued by the Hub to a single-user server when launched and is used to communicate with the Hub's APIs such as posting activity or completing the OAuth flow. This token has no expiry by default.
|
||||
|
||||
API tokens can also be issued to users via API ([_/hub/token_](../reference/urls.md) or [_POST /users/:username/tokens_](../reference/rest-api.rst)) and services via `jupyterhub_config.py` to perform API requests.
|
||||
API tokens can also be issued to users via API ([_/hub/token_](../reference/urls.md) or [_POST /users/:username/tokens_](../reference/rest-api.md)) and services via `jupyterhub_config.py` to perform API requests.
|
||||
|
||||
### With RBAC
|
||||
|
||||
|
@@ -3,7 +3,7 @@
|
||||
To determine which scopes a role should have, one can follow these steps:
|
||||
|
||||
1. Determine what actions the role holder should have/have not access to
|
||||
2. Match the actions against the [JupyterHub's APIs](../reference/rest-api.rst)
|
||||
2. Match the actions against the [JupyterHub's APIs](../reference/rest-api.md)
|
||||
3. Check which scopes are required to access the APIs
|
||||
4. Combine scopes and subscopes if applicable
|
||||
5. Customize the scopes with filters if needed
|
||||
|
@@ -7,7 +7,7 @@ installation version, as the output of this command may change between versions.
|
||||
|
||||
## JupyterHub configuration
|
||||
|
||||
As explained in the [Configuration Basics](../getting-started/config-basics.html#generate-a-default-config-file)
|
||||
As explained in the [Configuration Basics](generate-config-file)
|
||||
section, the `jupyterhub_config.py` can be automatically generated via
|
||||
|
||||
> ```bash
|
||||
|
@@ -110,7 +110,7 @@ working directory:
|
||||
This file needs to persist so that a **Hub** server restart will avoid
|
||||
invalidating cookies. Conversely, deleting this file and restarting the server
|
||||
effectively invalidates all login cookies. The cookie secret file is discussed
|
||||
in the [Cookie Secret section of the Security Settings document](../getting-started/security-basics.rst).
|
||||
in the [Cookie Secret section of the Security Settings document](../getting-started/security-basics.md).
|
||||
|
||||
The location of these files can be specified via configuration settings. It is
|
||||
recommended that these files be stored in standard UNIX filesystem locations,
|
||||
|
Reference in New Issue
Block a user