Edit per @minrk and added troubleshooting

This commit is contained in:
Carol Willing
2016-02-01 14:17:14 -08:00
parent 641154bf06
commit 84916062f0
3 changed files with 15 additions and 4 deletions

View File

@@ -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

View File

@@ -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

View 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``