mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-07 10:04:07 +00:00
7ddd3b0589
`Configuration Reference` sounds like it's the place to go to see the full list of JupyterHub config options. However it's not very readable as it's a plain-text dump of the output of `jupyterhub --generate-config`. This links to some of the API doc pages instead, which present most of the information in an easier to read format. Unfortunately it also includes a lot of non-traitlets documentation.
36 lines
807 B
Markdown
36 lines
807 B
Markdown
# Configuration Reference
|
|
|
|
:::{important}
|
|
Make sure the version of JupyterHub for this documentation matches your
|
|
installation version, as the output of this command may change between versions.
|
|
:::
|
|
|
|
## JupyterHub configuration
|
|
|
|
As explained in the [Configuration Basics](generate-config-file)
|
|
section, the `jupyterhub_config.py` can be automatically generated via
|
|
|
|
> ```bash
|
|
> jupyterhub --generate-config
|
|
> ```
|
|
|
|
Most of this information is available in a nicer format in:
|
|
|
|
- [](./api/app.md)
|
|
- [](./api/auth.md)
|
|
- [](./api/spawner.md)
|
|
|
|
The following contains the output of that command for reference.
|
|
|
|
```{eval-rst}
|
|
.. jupyterhub-generate-config::
|
|
```
|
|
|
|
## JupyterHub help command output
|
|
|
|
This section contains the output of the command `jupyterhub --help-all`.
|
|
|
|
```{eval-rst}
|
|
.. jupyterhub-help-all::
|
|
```
|