mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-18 07:23:00 +00:00
Edit per @minrk and added troubleshooting
This commit is contained in:
@@ -97,8 +97,7 @@ on the config system Jupyter uses.
|
||||
## Networking
|
||||
|
||||
### Configuring the Proxy's IP address and port
|
||||
Most use cases will require a change of the Proxy's main IP address and port.
|
||||
The main IP address setting determines where JupyterHub is available to users.
|
||||
The Proxy's main IP address setting determines where JupyterHub is available to users.
|
||||
By default, JupyterHub is configured to be available on all network interfaces
|
||||
(`''`) on port 8000. **Note**: Use of `'*'` is discouraged for IP configuration;
|
||||
instead, use of `'0.0.0.0'` is preferred.
|
||||
@@ -405,9 +404,9 @@ jupyterhub -f /path/to/aboveconfig.py
|
||||
|
||||
# Further reading
|
||||
|
||||
- TODO: troubleshooting
|
||||
- [Custom Authenticators](./authenticators.html)
|
||||
- [Custom Spawners](./spawners.html)
|
||||
- [Troubleshooting](./troubleshooting.html)
|
||||
|
||||
|
||||
[oauth-setup]: https://github.com/jupyter/oauthenticator#setup
|
||||
|
@@ -29,7 +29,7 @@ Basic principles:
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:maxdepth: 2
|
||||
:caption: User Documentation
|
||||
|
||||
getting-started
|
||||
@@ -41,6 +41,7 @@ Contents:
|
||||
|
||||
authenticators
|
||||
spawners
|
||||
troubleshooting
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
11
docs/source/troubleshooting.md
Normal file
11
docs/source/troubleshooting.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Troubleshooting
|
||||
|
||||
This document is under active development.
|
||||
|
||||
## Networking
|
||||
|
||||
If JupyterHub proxy fails to start:
|
||||
|
||||
- check if the JupyterHub IP configuration setting is
|
||||
``c.JupyterHub.ip = '*'``; if it is, try ``c.JupyterHub.ip = ''``
|
||||
- Try starting with ``jupyterhub --ip=0.0.0.0``
|
Reference in New Issue
Block a user