diff options
Diffstat (limited to 'doc/administration/auth/jwt.md')
| -rw-r--r-- | doc/administration/auth/jwt.md | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/doc/administration/auth/jwt.md b/doc/administration/auth/jwt.md index 26e523cb802..9298b04cbc1 100644 --- a/doc/administration/auth/jwt.md +++ b/doc/administration/auth/jwt.md @@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # JWT OmniAuth provider **(FREE SELF)** To enable the JWT OmniAuth provider, you must register your application with JWT. -JWT will provide you with a secret key for you to use. +JWT provides you with a secret key for you to use. 1. On your GitLab server, open the configuration file. @@ -32,14 +32,15 @@ JWT will provide you with a secret key for you to use. ```ruby gitlab_rails['omniauth_providers'] = [ - { name: 'jwt', + { name: "jwt", + label: "Provider name", # optional label for login button, defaults to "Jwt" args: { - secret: 'YOUR_APP_SECRET', - algorithm: 'HS256', # Supported algorithms: 'RS256', 'RS384', 'RS512', 'ES256', 'ES384', 'ES512', 'HS256', 'HS384', 'HS512' - uid_claim: 'email', - required_claims: ['name', 'email'], - info_map: { name: 'name', email: 'email' }, - auth_url: 'https://example.com/', + secret: "YOUR_APP_SECRET", + algorithm: "HS256", # Supported algorithms: "RS256", "RS384", "RS512", "ES256", "ES384", "ES512", "HS256", "HS384", "HS512" + uid_claim: "email", + required_claims: ["name", "email"], + info_map: { name: "name", email: "email" }, + auth_url: "https://example.com/", valid_within: 3600 # 1 hour } } @@ -50,6 +51,7 @@ JWT will provide you with a secret key for you to use. ```yaml - { name: 'jwt', + label: 'Provider name', # optional label for login button, defaults to "Jwt" args: { secret: 'YOUR_APP_SECRET', algorithm: 'HS256', # Supported algorithms: 'RS256', 'RS384', 'RS512', 'ES256', 'ES384', 'ES512', 'HS256', 'HS384', 'HS512' @@ -72,9 +74,9 @@ JWT will provide you with a secret key for you to use. installed GitLab via Omnibus or from source respectively. On the sign in page there should now be a JWT icon below the regular sign in form. -Click the icon to begin the authentication process. JWT will ask the user to +Click the icon to begin the authentication process. JWT asks the user to sign in and authorize the GitLab application. If everything goes well, the user -will be redirected to GitLab and will be signed in. +is redirected to GitLab and signed in. <!-- ## Troubleshooting |