Skip to content

Commit e83c73e

Browse files
committed
Explicitly document base URL behavior. This README should probably eventually be split into separate files in a proper folder, but one step at a time
1 parent 3d334d2 commit e83c73e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@ $ docker run -p 8080:8080 -e 'GITHUB_OAUTH_KEY=YOURKEY' \
4343

4444
With this configured all GitHub API requests will go to your Enterprise instance so you can view all of your internal notebooks.
4545

46+
## Base URL
47+
48+
If the environment variable `JUPYTERHUB_SERVICE_PREFIX` is specified, then NBViewer _always_ uses the value of this environment variable as the base URL.
49+
50+
In the case that there is no value for `JUPYTERHUB_SERVICE_PREFIX`, then as a backup the value of the `--base-url` flag passed to the `python -m nbviewer` command on the command line will be used as the base URL.
51+
4652
## Local Development
4753

4854
### With Docker

0 commit comments

Comments
 (0)