Skip to content

Commit 8b477f0

Browse files
authored
Default values for OmniAuth OpenID Connect environment variables are now listed in README.md.
1 parent de8d0d5 commit 8b477f0

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
- [Crowd](#crowd)
4747
- [Microsoft Azure](#microsoft-azure)
4848
- [Generic OAuth2](#Generic-OAuth2)
49-
- [OpenID Connect](#OpenID-Connect)
49+
- [OpenID Connect](#openid-connect)
5050
- [Gitlab Pages](#gitlab-pages)
5151
- [External Issue Trackers](#external-issue-trackers)
5252
- [Host UID / GID Mapping](#host-uid--gid-mapping)
@@ -732,21 +732,21 @@ To enable OpenID Connect provider, you must register your application with your
732732

733733
To use OIDC set at least `OAUTH_OIDC_ISSUER` and `OAUTH_OIDC_CLIENT_ID`.
734734

735-
| GitLab setting | environment variable |
736-
|----------------|----------------------|
737-
| `label` | `OAUTH_OIDC_LABEL` |
738-
| `icon` | `OAUTH_OIDC_ICON` |
739-
| `scope`| `OAUTH_OIDC_SCOPE` |
740-
| `response_type` | `OAUTH_OIDC_RESPONSE_TYPE` |
741-
| `issuer` | `OAUTH_OIDC_ISSUER` |
742-
| `discovery` | `OAUTH_OIDC_DISCOVERY` |
743-
| `client_auth_method` | `OAUTH_OIDC_CLIENT_AUTH_METHOD` |
744-
| `uid_field` | `OAUTH_OIDC_UID_FIELD` |
745-
| `send_scope_to_token_endpoint` | `OAUTH_OIDC_SEND_SCOPE_TO_TOKEN_EP` |
746-
| `pkce` | `OAUTH_OIDC_PKCE` |
747-
| `client_options.identifier` | `OAUTH_OIDC_CLIENT_ID` |
748-
| `client_options.secret` | `OAUTH_OIDC_CLIENT_SECRET` |
749-
| `client_options.redirect_uri` | `OAUTH_OIDC_REDIRECT_URI` |
735+
| GitLab setting | environment variable | default value |
736+
|--------------------------------|-------------------------------------|--------------------------------|
737+
| `label` | `OAUTH_OIDC_LABEL` | `OpenID Connect` |
738+
| `icon` | `OAUTH_OIDC_ICON` | |
739+
| `scope` | `OAUTH_OIDC_SCOPE` | `['openid','profile','email']` |
740+
| `response_type` | `OAUTH_OIDC_RESPONSE_TYPE` | `code` |
741+
| `issuer` | `OAUTH_OIDC_ISSUER` | |
742+
| `discovery` | `OAUTH_OIDC_DISCOVERY` | `true` |
743+
| `client_auth_method` | `OAUTH_OIDC_CLIENT_AUTH_METHOD` | `basic` |
744+
| `uid_field` | `OAUTH_OIDC_UID_FIELD` | `sub` |
745+
| `send_scope_to_token_endpoint` | `OAUTH_OIDC_SEND_SCOPE_TO_TOKEN_EP` | `false` |
746+
| `pkce` | `OAUTH_OIDC_PKCE` | `true` |
747+
| `client_options.identifier` | `OAUTH_OIDC_CLIENT_ID` | |
748+
| `client_options.secret` | `OAUTH_OIDC_CLIENT_SECRET` | `secret` |
749+
| `client_options.redirect_uri` | `OAUTH_OIDC_REDIRECT_URI` | `http://${GITLAB_HOST}/users/auth/openid_connect/callback` or `https://${GITLAB_HOST}/users/auth/openid_connect/callback` depending on the value of `GITLAB_HTTPS` |
750750

751751
See [GitLab OIDC documentation](https://docs.gitlab.com/ee/administration/auth/oidc.html) and [OmniAuth OpenID Connect documentation](https://github.com/omniauth/omniauth_openid_connect/).
752752

0 commit comments

Comments
 (0)