diff options
author | Drew Blessing <drew@gitlab.com> | 2017-03-07 11:58:30 -0600 |
---|---|---|
committer | Drew Blessing <drew@gitlab.com> | 2017-03-07 11:58:30 -0600 |
commit | 79bee6a2ecdba480e97b9a1a2b1729ec6dac05c6 (patch) | |
tree | a4c60702eb9f330c385c6de8f83f54f1a18ff3fc /doc/administration | |
parent | 509ff2ab170802e23646282f1d146a6383b53a66 (diff) | |
download | gitlab-ce-79bee6a2ecdba480e97b9a1a2b1729ec6dac05c6.tar.gz |
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.
Diffstat (limited to 'doc/administration')
-rw-r--r-- | doc/administration/auth/crowd.md | 68 | ||||
-rw-r--r-- | doc/administration/auth/img/crowd_application.png | bin | 0 -> 55811 bytes |
2 files changed, 68 insertions, 0 deletions
diff --git a/doc/administration/auth/crowd.md b/doc/administration/auth/crowd.md new file mode 100644 index 00000000000..2c289c67a6d --- /dev/null +++ b/doc/administration/auth/crowd.md @@ -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. + + ![Example Crowd application configuration](img/crowd_application.png) + +## 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 diff --git a/doc/administration/auth/img/crowd_application.png b/doc/administration/auth/img/crowd_application.png Binary files differnew file mode 100644 index 00000000000..7deea9dac8e --- /dev/null +++ b/doc/administration/auth/img/crowd_application.png |