Skip to content

Commit d6b27c6

Browse files
authored
Merge pull request #503 from jupyterlab/fcollonval-patch-1
Improve troubleshooting following issues
2 parents eac6a5d + a51cda1 commit d6b27c6

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,45 @@ jupyter lab build
2828

2929
### Troubleshooting
3030

31-
- When you run JupyterLab, if you can see the Git sidepanel UI but you cannot get it to work, you may need to explicitly enable the serverextension by running:
31+
Before consulting the following list, be sure the server extension and the frontend extension have the same version by executing the following commands:
3232

3333
```bash
34-
jupyter serverextension enable --py jupyterlab_git
34+
jupyter serverextension list
35+
jupyter labextension list
3536
```
3637

38+
- **Issue**: the Git panel does not recognize that you are in a Git repository.
39+
40+
Possible fixes:
41+
42+
- Be sure to be in a Git repository in the filebrowser tab
43+
44+
- Check the server log. If you see a warning with a 404 code similar to:
45+
`[W 00:27:41.800 LabApp] 404 GET /git/server_root?1576081660665`
46+
47+
Explicitly enable the server extension by running:
48+
```bash
49+
jupyter serverextension enable --py jupyterlab_git
50+
```
51+
52+
- If you are using JupyterHub or some other technologies requiring an initialization script which includes the jupyterlab-git extension, be sure to install both the frontend and the server extension **before** launching JupyterLab.
53+
54+
- **Issue**: the Git panel is not visible.
55+
56+
Possible fixes:
57+
58+
- Check that the JupyterLab extension is installed:
59+
60+
```bash
61+
jupyter labextension list
62+
```
63+
64+
If you don't see `@jupyterlab/git v... enabled OK` in the list, explicitly install the jupyter labextension by running:
65+
66+
```bash
67+
jupyter labextension @jupyterlab/git
68+
```
69+
3770
## Development
3871
3972
### Contributing

0 commit comments

Comments
 (0)