@@ -28,16 +28,16 @@ If you need help using or installing Jupyter Notebook Viewer, please use the [ju
28
28
If you have ` docker ` installed, you can pull and run the currently built version of the Docker container by
29
29
30
30
``` shell
31
- $ docker pull jupyter/nbviewer
32
- $ docker run -p 8080:8080 jupyter/nbviewer
31
+ docker pull jupyter/nbviewer
32
+ docker run -p 8080:8080 jupyter/nbviewer
33
33
```
34
34
35
35
It automatically gets built with each push to ` master ` , so you'll always be able to get the freshest copy.
36
36
37
37
For speed and friendliness to GitHub, be sure to set ` GITHUB_OAUTH_KEY ` and ` GITHUB_OAUTH_SECRET ` :
38
38
39
39
``` shell
40
- $ docker run -p 8080:8080 -e ' GITHUB_OAUTH_KEY=YOURKEY' \
40
+ docker run -p 8080:8080 -e ' GITHUB_OAUTH_KEY=YOURKEY' \
41
41
-e ' GITHUB_OAUTH_SECRET=YOURSECRET' \
42
42
jupyter/nbviewer
43
43
```
@@ -52,7 +52,7 @@ The relevant [API endpoints for GitHub Enterprise](https://developer.github.com/
52
52
You must also specify your ` OAUTH ` or ` API_TOKEN ` as explained above. For example:
53
53
54
54
``` shell
55
- $ docker run -p 8080:8080 -e ' GITHUB_OAUTH_KEY=YOURKEY' \
55
+ docker run -p 8080:8080 -e ' GITHUB_OAUTH_KEY=YOURKEY' \
56
56
-e ' GITHUB_OAUTH_SECRET=YOURSECRET' \
57
57
-e ' GITHUB_API_URL=https://ghe.example.com/api/v3/' \
58
58
jupyter/nbviewer
@@ -76,16 +76,16 @@ You can build a docker image that uses your local branch.
76
76
#### Build
77
77
78
78
``` shell
79
- $ cd < path to repo>
80
- $ docker build -t nbviewer .
79
+ cd < path to repo>
80
+ docker build -t nbviewer .
81
81
```
82
82
83
83
84
84
#### Run
85
85
86
86
``` shell
87
- $ cd < path to repo>
88
- $ docker run -p 8080:8080 nbviewer
87
+ cd < path to repo>
88
+ docker run -p 8080:8080 nbviewer
89
89
```
90
90
91
91
### With Docker Compose
@@ -99,9 +99,9 @@ to this.
99
99
#### Run
100
100
101
101
``` shell
102
- $ cd < path to repo>
103
- $ pip install docker-compose
104
- $ docker-compose up
102
+ cd < path to repo>
103
+ pip install docker-compose
104
+ docker-compose up
105
105
```
106
106
107
107
0 commit comments