hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-18 15:33:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update troubleshooting.md

Browse Source
This commit is contained in:
PoorvajaRayas
2022-10-20 17:24:55 +05:30
committed by GitHub
parent b890a7486d
commit cd3f37f6a6
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/source/troubleshooting.md
View File

@@ -1,6 +1,6 @@
# Troubleshooting # Troubleshooting
While troubleshooting, you may see unexpected behaviors or receive an error When troubleshooting, you may see unexpected behaviors or receive an error
message. This section provides links for identifying the cause of the message. This section provides links for identifying the cause of the
problem and how to resolve it. problem and how to resolve it.
@@ -8,14 +8,14 @@ problem and how to resolve it.
### JupyterHub proxy fails to start ### JupyterHub proxy fails to start
If you have tried to start the JupyterHub proxy and it fails to run: If you have tried to start the JupyterHub proxy and it fails to start:
- check if the JupyterHub IP configuration setting is - check if the JupyterHub IP configuration setting is
`c.JupyterHub.ip = '*'`; if it is, try `c.JupyterHub.ip = ''` `c.JupyterHub.ip = '*'`; if it is, try `c.JupyterHub.ip = ''`
- Try starting with `jupyterhub --ip=0.0.0.0` - Try starting with `jupyterhub --ip=0.0.0.0`
**Note**: If this occurs on Ubuntu/Debian, check that you are using a **Note**: If this occurs on Ubuntu/Debian, check that you are using a
recent version of [Node](https://nodejs.org). Some versions of Ubuntu/Debian come with an older version recent version of [Node](https://nodejs.org). Some versions of Ubuntu/Debian come with a very old version
of Node and it is necessary to update Node. of Node and it is necessary to update Node.
### sudospawner fails to run ### sudospawner fails to run
@@ -37,7 +37,7 @@ to the config file, `jupyterhub_config.py`.
When nothing is given for these lists, there will be no admins, and all users When nothing is given for these lists, there will be no admins, and all users
who can authenticate on the system (i.e. all the Unix users on the server with who can authenticate on the system (i.e. all the Unix users on the server with
a password) will be allowed to start a server. The allowed username set lets you limit a password) will be allowed to start a server. The allowed username set lets you limit
this to a particular set of users, and admin_users let you specify who this to a particular set of users, and admin_users lets you specify who
among them may use the admin interface (not necessary, unless you need to do among them may use the admin interface (not necessary, unless you need to do
things like inspect other users' servers or modify the user list at runtime). things like inspect other users' servers or modify the user list at runtime).
@@ -87,7 +87,7 @@ sudo MY_ENV=abc123 \
### Error 500 after spawning my single-user server ### Error 500 after spawning my single-user server
You receive an Error 500 while accessing the URL `/user/<your_name>/...`. You receive a 500 error while accessing the URL `/user/<your_name>/...`.
This is often seen when your single-user server cannot verify your user cookie This is often seen when your single-user server cannot verify your user cookie
with the Hub. with the Hub.
@@ -100,7 +100,7 @@ There are two likely reasons for this:
#### Symptoms #### Symptoms
The main symptom is a failure to load _any_ page served by the single-user The main symptom is a failure to load _any_ page served by the single-user
server, met with an Error 500. This is typically the first page at `/user/<your_name>` server, met with a 500 error. This is typically the first page at `/user/<your_name>`
after logging in or clicking "Start my server". When a single-user notebook server after logging in or clicking "Start my server". When a single-user notebook server
receives a request, the notebook server makes an API request to the Hub to receives a request, the notebook server makes an API request to the Hub to
check if the cookie corresponds to the right user. This request is logged. check if the cookie corresponds to the right user. This request is logged.
@@ -167,7 +167,7 @@ When your whole JupyterHub sits behind an organization proxy (_not_ a reverse pr
[JupyterHub services](https://jupyterhub.readthedocs.io/en/stable/reference/services.html) allow processes to interact with JupyterHub's REST API. Example use-cases include: [JupyterHub services](https://jupyterhub.readthedocs.io/en/stable/reference/services.html) allow processes to interact with JupyterHub's REST API. Example use-cases include:
- **Secure Testing**: provides a canonical Jupyter Notebook for testing production data to reduce the number of entry points into production systems. - **Secure Testing**: provide a canonical Jupyter Notebook for testing production data to reduce the number of entry points into production systems.
- **Grading Assignments**: provide access to shared Jupyter Notebooks that may be used for management tasks such as grading assignments. - **Grading Assignments**: provide access to shared Jupyter Notebooks that may be used for management tasks such as grading assignments.
- **Private Dashboards**: share dashboards with certain group members. - **Private Dashboards**: share dashboards with certain group members.
@@ -324,7 +324,7 @@ Or use syslog:
### Toree integration with HDFS rack awareness script ### Toree integration with HDFS rack awareness script
The Apache Toree kernel will have an issue while running with JupyterHub if the standard HDFS The Apache Toree kernel will have an issue when running with JupyterHub if the standard HDFS
rack awareness script is used. This will materialize in the logs as a repeated WARN: rack awareness script is used. This will materialize in the logs as a repeated WARN:
```bash ```bash
@@ -371,7 +371,7 @@ You can also tail logs to view them in real-time using the `-f` option:
## Troubleshooting commands ## Troubleshooting commands
The following commands provide additional detail about installed packages, The following commands provide additional detail about installed packages,
versions, and system information that may be helpful while troubleshooting versions, and system information that may be helpful when troubleshooting
a JupyterHub deployment. The commands are: a JupyterHub deployment. The commands are:
- System and deployment information - System and deployment information