Document environment variables

This commit is contained in:
Valentin Brandl 2019-07-28 14:42:59 +02:00
parent 84e9ee2a51
commit 209ccb7093
No known key found for this signature in database
GPG Key ID: 30D341DD34118D7D

View File

@ -24,3 +24,14 @@ To get the `HEAD` of a requested branch, Gitache sends a request to the
requested service's API. To prevent running into rate limiting issues with the
GitHub API, an OAuth2 App should be created and the client ID and secret can be
set via the `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET` environment variables.
## Variables
| Environment Variable | CLI Flag | Description |
| --- | --- | --- |
| `GITHUB_CLIENT_SECRET` | `--gh-secret` | GitHub OAuth2 secret (optional) |
| `GITHUB_CLIENT_ID` | `--gh-id` | GH OAuth2 Client ID (optional) |
| `CF_ZONE_IDENT` | `--cf-zone` | Cloudflare Zone identifier |
| `CF_AUTH_USER` | `--cf-auth-user` | CF API User (`X-Auth-Email`) |
| `CF_AUTH_KEY` | `--cf-auth-key` | CF API Key (`X-Auth-Key`) |
| `HOSTNAME` | `--hostname` | Hostname (default: `gitcdn.tk`) |