Skip to content

Commit 0d4fb93

Browse files
shepmastershepmaster
committed
Document PLAYGROUND_GITHUB_TOKEN
1 parent 7636685 commit 0d4fb93

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

‎ui/README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
## Configuration
22

3-
| Key | Required | Default Value | Description |
4-
| ------------------------|-----------|-----------------|-------------------------------------------------------------------------|
5-
| `PLAYGROUND_UI_ROOT` | **Yes** | | The path to the HTML, CSS, and Javascript files |
6-
| `PLAYGROUND_UI_ADDRESS` | No | 127.0.0.1 | The address to listen on |
7-
| `PLAYGROUND_UI_PORT` | No | 5000 | The port to listen on |
8-
| `PLAYGROUND_LOG_FILE` | No | access-log.csv | The file to record accesses |
9-
| `TMPDIR` | No | system-provided | Where compilation artifacts will be saved. Must be accessible to Docker |
3+
In production, these should be set according to your deployment method
4+
of choice.
5+
6+
| Key | Required | Default Value | Description |
7+
| --------------------------|----------|-----------------|-------------------------------------------------------------------------|
8+
| `PLAYGROUND_UI_ROOT` | **Yes** | | The path to the HTML, CSS, and Javascript files |
9+
| `PLAYGROUND_GITHUB_TOKEN` | **Yes** | | The [GitHub API token][gist] to read and write Gists |
10+
| `PLAYGROUND_UI_ADDRESS` | No | 127.0.0.1 | The address to listen on |
11+
| `PLAYGROUND_UI_PORT` | No | 5000 | The port to listen on |
12+
| `PLAYGROUND_LOG_FILE` | No | access-log.csv | The file to record accesses |
13+
| `TMPDIR` | No | system-provided | Where compilation artifacts will be saved. Must be accessible to Docker |
14+
15+
[gist]: https://developer.github.com/v3/gists/#authentication

0 commit comments

Comments
 (0)