Move and update Crowd authentication documentation
Current docs did not include information on configuring the app in Crowd. Also, moved the doc to the new administration/auth directory.
This commit is contained in:
Drew Blessing
parent
509ff2ab17
commit
79bee6a2ec
4 changed files with 70 additions and 64 deletions
68
doc/administration/auth/crowd.md
Normal file
68
doc/administration/auth/crowd.md
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
# Atlassian Crowd OmniAuth Provider
|
||||
|
||||
## Configure a new Crowd application
|
||||
|
||||
1. Choose 'Applications' in the top menu, then 'Add application'.
|
||||
1. Go through the 'Add application' steps, entering the appropriate details.
|
||||
The screenshot below shows an example configuration.
|
||||
|
||||
|
||||
|
||||
## Configure GitLab
|
||||
|
||||
1. On your GitLab server, open the configuration file.
|
||||
|
||||
**Omnibus:**
|
||||
|
||||
```sh
|
||||
sudo editor /etc/gitlab/gitlab.rb
|
||||
```
|
||||
|
||||
**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:
|
||||
|
||||
**Omnibus:**
|
||||
|
||||
```ruby
|
||||
gitlab_rails['omniauth_providers'] = [
|
||||
{
|
||||
"name" => "crowd",
|
||||
"args" => {
|
||||
"crowd_server_url" => "CROWD_SERVER_URL",
|
||||
"application_name" => "YOUR_APP_NAME",
|
||||
"application_password" => "YOUR_APP_PASSWORD"
|
||||
}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
**Source:**
|
||||
|
||||
```
|
||||
- { name: 'crowd',
|
||||
args: {
|
||||
crowd_server_url: 'CROWD_SERVER_URL',
|
||||
application_name: 'YOUR_APP_NAME',
|
||||
application_password: 'YOUR_APP_PASSWORD' } }
|
||||
```
|
||||
1. Change `CROWD_SERVER_URL` to the URL of your Crowd server.
|
||||
1. Change `YOUR_APP_NAME` to the application name from Crowd applications page.
|
||||
1. Change `YOUR_APP_PASSWORD` to the application password you've set.
|
||||
1. Save the configuration file.
|
||||
1. [Reconfigure][] or [restart][] 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 Crowd tab in the sign in form.
|
||||
|
||||
[reconfigure]: ../restart_gitlab.md#omnibus-gitlab-reconfigure
|
||||
[restart]: ../restart_gitlab.md#installations-from-source
|
||||
BIN
doc/administration/auth/img/crowd_application.png
Normal file
BIN
doc/administration/auth/img/crowd_application.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
|
|
@ -1,63 +1 @@
|
|||
# Crowd OmniAuth Provider
|
||||
|
||||
To enable the Crowd OmniAuth provider you must register your application with Crowd. To configure Crowd integration you need an application name and password.
|
||||
|
||||
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" => "crowd",
|
||||
"args" => {
|
||||
"crowd_server_url" => "CROWD",
|
||||
"application_name" => "YOUR_APP_NAME",
|
||||
"application_password" => "YOUR_APP_PASSWORD"
|
||||
}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
For installations from source:
|
||||
|
||||
```
|
||||
- { name: 'crowd',
|
||||
args: {
|
||||
crowd_server_url: 'CROWD SERVER URL',
|
||||
application_name: 'YOUR_APP_NAME',
|
||||
application_password: 'YOUR_APP_PASSWORD' } }
|
||||
```
|
||||
|
||||
1. Change 'YOUR_APP_NAME' to the application name from Crowd applications page.
|
||||
|
||||
1. Change 'YOUR_APP_PASSWORD' to the application password you've set.
|
||||
|
||||
1. Save the configuration file.
|
||||
|
||||
1. [Reconfigure][] 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 Crowd tab in the sign in form.
|
||||
|
||||
[reconfigure]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
|
||||
[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source
|
||||
|
||||
This document was moved to [`administration/auth/crowd`](../administration/auth/crowd.md).
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ contains some settings that are common for all providers.
|
|||
- [Twitter](twitter.md)
|
||||
- [Shibboleth](shibboleth.md)
|
||||
- [SAML](saml.md)
|
||||
- [Crowd](crowd.md)
|
||||
- [Crowd](../administration/auth/crowd.md)
|
||||
- [Azure](azure.md)
|
||||
- [Auth0](auth0.md)
|
||||
- [Authentiq](../administration/auth/authentiq.md)
|
||||
|
|
|
|||
Loading…
Reference in a new issue