add env var description to readme

Signed-off-by: Michael Mumenthaler <michi.mumi@gmail.com>
netricsag · Jan 30, 2022 · f853f13 · f853f13
1 parent c53215b
commit f853f13
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,15 @@
 # tenant-dashboard
+
 The dashboard frontend of tenants
+
+## Environment variables
+
+To configure the tenant dashboard with your settings, fill your information in the env-config.json.
+
+### Description
+
+| Env Variable               | Type                           | Description                                                                                    |
+| -------------------------- | :----------------------------- | ---------------------------------------------------------------------------------------------- |
+| `REACT_APP_CLIENT_ID:`     | [string] <YOUR_CLIENT_ID_HERE> | GitHub App client ID                                                                           |
+| `REACT_APP_REDIRECT_URI:`  | [string] <REDIRECT_URL>        | GitHub App redirect URL (Should point back at the frontend, i.e. https://yourdomain.com/login) |
+| `REACT_APP_API_OAUTH_URI:` | [string] <OAUTH_URL>           | GitHub OAuth URL                                                                               |