Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Jérome Perrin
gitlab-ce
Commits
d2608d36
Commit
d2608d36
authored
Mar 26, 2018
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Copyedit JWT docs
parent
fe82ef0c
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
73 additions
and
75 deletions
+73
-75
doc/administration/auth/jwt.md
doc/administration/auth/jwt.md
+72
-0
doc/integration/jwt.md
doc/integration/jwt.md
+0
-74
doc/integration/omniauth.md
doc/integration/omniauth.md
+1
-1
No files found.
doc/administration/auth/jwt.md
0 → 100644
View file @
d2608d36
# JWT OmniAuth provider
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.
1.
On your GitLab server, open the configuration file.
For Omnibus GitLab:
```sh
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
```sh
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
1.
See
[
Initial OmniAuth Configuration
](
../../integration/omniauth.md#initial-omniauth-configuration
)
for initial settings.
1.
Add the provider configuration.
For Omnibus GitLab:
```ruby
gitlab_rails['omniauth_providers'] = [
{ name: 'jwt',
app_secret: 'YOUR_APP_SECRET',
args: {
algorithm: 'HS256',
uid_claim: 'email',
required_claims: ["name", "email"],
info_maps: { name: "name", email: "email" },
auth_url: 'https://example.com/',
valid_within: nil,
}
}
]
```
For installation from source:
```
- { name: 'jwt',
app_secret: 'YOUR_APP_SECRET',
args: {
algorithm: 'HS256',
uid_claim: 'email',
required_claims: ["name", "email"],
info_map: { name: "name", email: "email" },
auth_url: 'https://example.com/',
valid_within: nil,
}
}
```
NOTE: **Note:** For more information on each configuration option refer to
the [OmniAuth JWT usage documentation](https://github.com/mbleigh/omniauth-jwt#usage).
1.
Change
`YOUR_APP_SECRET`
to the client secret.
1.
Save the configuration file.
1.
[
Reconfigure GitLab
][]
or
[
restart GitLab
][]
for the changes to take effect if you
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
sign in and authorize the GitLab application. If everything goes well, the user
will be redirected to GitLab and will be signed in.
[
reconfigure GitLab
]:
../restart_gitlab.md#omnibus-gitlab-reconfigure
[
restart GitLab
]:
../restart_gitlab.md#installations-from-source
doc/integration/jwt.md
deleted
100644 → 0
View file @
fe82ef0c
# Integrate your server with JWT
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.
1.
On your GitLab server, open the configuration file.
For omnibus package:
```sh
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
```sh
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
1.
See
[
Initial OmniAuth Configuration
](
omniauth.md#initial-omniauth-configuration
)
for initial settings.
1.
Add the provider configuration:
For omnibus package:
```ruby
gitlab_rails['omniauth_providers'] = [
{ name: 'jwt',
app_secret: 'YOUR_APP_SECRET',
args: {
algorithm: 'HS256',
uid_claim: 'email',
required_claims: ["name", "email"],
info_maps: { name: "name", email: "email" },
auth_url: 'https://example.com/',
valid_within: nil,
}
}
]
```
For installation from source:
```
- { name: 'jwt',
app_secret: 'YOUR_APP_SECRET',
args: {
algorithm: 'HS256',
uid_claim: 'email',
required_claims: ["name", "email"],
info_map: { name: "name", email: "email" },
auth_url: 'https://example.com/',
valid_within: nil,
}
}
```
__For more information on each configuration option refer to the [OmniAuth JWT usage documentation](https://github.com/mbleigh/omniauth-jwt#usage).__
1.
Change 'YOUR_APP_SECRET' to the client secret.
1.
Save the configuration file.
1.
[
Reconfigure GitLab
][]
or
[
restart GitLab
][]
for the changes to take effect if you
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 sign in and authorize the GitLab application.
If everything goes well the user will be returned to GitLab and will be signed in.
[
reconfigure GitLab
]:
../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
[
restart GitLab
]:
../administration/restart_gitlab.md#installations-from-source
doc/integration/omniauth.md
View file @
d2608d36
...
...
@@ -32,7 +32,7 @@ contains some settings that are common for all providers.
-
[
Auth0
](
auth0.md
)
-
[
Authentiq
](
../administration/auth/authentiq.md
)
-
[
OAuth2Generic
](
oauth2_generic.md
)
-
[
JWT
](
jwt.md
)
-
[
JWT
](
../administration/auth/
jwt.md
)
## Initial OmniAuth Configuration
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment