From 209ccb70936de94d0168c3fcd22cf0cc022cbb18 Mon Sep 17 00:00:00 2001 From: Valentin Brandl Date: Sun, 28 Jul 2019 14:42:59 +0200 Subject: [PATCH] Document environment variables --- backend/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/backend/README.md b/backend/README.md index 6642af5..2799c59 100644 --- a/backend/README.md +++ b/backend/README.md @@ -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`) |