Skip to content

Commit 319ea4a

Browse files
Update env vars in README
1 parent e773196 commit 319ea4a

1 file changed

Lines changed: 27 additions & 26 deletions

File tree

README.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ Accent provides a powerful abstraction around the process maintaining translatio
2424

2525
## Contents
2626

27-
| Section | Description |
28-
| --------------------------------------------------- | -------------------------------------------------------------------- |
27+
| Section | Description |
28+
| ---------------------------------------------------- | -------------------------------------------------------------------- |
2929
| [🚀 Getting started](#-getting-started) | Quickly setup a working app |
3030
| [🚧 Requirements](#-requirements) | Dependencies required to run Accent’ stack |
3131
| [🎛 Mix commands](#-executing-mix-commands) | How to execute mix task with the Twelve-Factor pattern |
3232
| [🏎 Quickstart](#-quickstart) | Steps to run the project, from API to webapp, with or without Docker |
3333
| [🌳 Environment variables](#-environment-variables) | Required and optional env var used |
34-
| [✅ Tests](#-tests) | How to run the extensive tests suite |
34+
| [✅ Tests](#-tests) | How to run the extensive tests suite |
3535
| [🚀 Heroku](#-deploy-on-heroku) | Easy deployment setup with Heroku |
3636
| [🌎 Contribute](#-contribute) | How to contribute to this repo |
3737

@@ -148,29 +148,30 @@ Accent provides a default value for every required environment variable. This me
148148

149149
Various login providers are included in Accent using Ueberauth to abstract services.
150150

151-
| Variable | Default | Description |
152-
| -------------------------- | ---------------------- | --------------------------------------------------------------------------------------- |
153-
| `DUMMY_LOGIN_ENABLED` | _none_ | If specified, the password-less authentication (with only the email) will be available. |
154-
| `GITHUB_CLIENT_ID` | _none_ | |
155-
| `GITHUB_CLIENT_SECRET` | _none_ | |
156-
| `GITLAB_CLIENT_ID` | _none_ | |
157-
| `GITLAB_CLIENT_SECRET` | _none_ | |
158-
| `GITLAB_SITE_URL` | `https://gitlab.com` | |
159-
| `GOOGLE_API_CLIENT_ID` | _none_ | |
160-
| `GOOGLE_API_CLIENT_SECRET` | _none_ | |
161-
| `SLACK_CLIENT_ID` | _none_ | |
162-
| `SLACK_CLIENT_SECRET` | _none_ | |
163-
| `SLACK_TEAM_ID` | _none_ | |
164-
| `DISCORD_CLIENT_ID` | _none_ | |
165-
| `DISCORD_CLIENT_SECRET` | _none_ | |
166-
| `MICROSOFT_CLIENT_ID` | _none_ | |
167-
| `MICROSOFT_CLIENT_SECRET` | _none_ | |
168-
| `MICROSOFT_TENANT_ID` | _none_ | |
169-
| `OIDC_CLIENT_ID` | _none_ | |
170-
| `OIDC_CLIENT_SECRET` | _none_ | |
171-
| `OIDC_DISCOVERY_URI` | _none_ | |
172-
| `OIDC_UID_FIELD` | `sub` | |
173-
| `OIDC_SCOPE` | `openid profile email` | |
151+
| Variable | Default | Description |
152+
| -------------------------- | ---------------------- | -------------------------------------------------------------------------------------------- |
153+
| `DUMMY_LOGIN_ENABLED` | _none_ | If specified, the password-less authentication (with only the email) will be available. |
154+
| `GITHUB_CLIENT_ID` | _none_ | |
155+
| `GITHUB_CLIENT_SECRET` | _none_ | |
156+
| `GITLAB_CLIENT_ID` | _none_ | |
157+
| `GITLAB_CLIENT_SECRET` | _none_ | |
158+
| `GITLAB_SITE_URL` | `https://gitlab.com` | |
159+
| `GOOGLE_API_CLIENT_ID` | _none_ | |
160+
| `GOOGLE_API_CLIENT_SECRET` | _none_ | |
161+
| `SLACK_CLIENT_ID` | _none_ | |
162+
| `SLACK_CLIENT_SECRET` | _none_ | |
163+
| `SLACK_TEAM_ID` | _none_ | |
164+
| `DISCORD_CLIENT_ID` | _none_ | |
165+
| `DISCORD_CLIENT_SECRET` | _none_ | |
166+
| `MICROSOFT_CLIENT_ID` | _none_ | |
167+
| `MICROSOFT_CLIENT_SECRET` | _none_ | |
168+
| `MICROSOFT_TENANT_ID` | _none_ | |
169+
| `OIDC_CLIENT_ID` | _none_ | |
170+
| `OIDC_CLIENT_SECRET` | _none_ | |
171+
| `OIDC_DISCOVERY_URI` | _none_ | URL to openid-configuration. Deprecated, use `OIDC_ISSUER` |
172+
| `OIDC_ISSUER` | _none_ | Issuer URL (e.g. `https://idp-website.example`, or `https://idp-website.example/realms/XXX`) |
173+
| `OIDC_UID_FIELD` | `sub` | |
174+
| `OIDC_SCOPE` | `openid profile email` | |
174175

175176
### Email setup
176177

0 commit comments

Comments
 (0)