From 79bee6a2ecdba480e97b9a1a2b1729ec6dac05c6 Mon Sep 17 00:00:00 2001
From: Drew Blessing <drew@gitlab.com>
Date: Tue, 7 Mar 2017 11:58:30 -0600
Subject: 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.
---
 doc/administration/auth/crowd.md                  |  68 ++++++++++++++++++++++
 doc/administration/auth/img/crowd_application.png | Bin 0 -> 55811 bytes
 2 files changed, 68 insertions(+)
 create mode 100644 doc/administration/auth/crowd.md
 create mode 100644 doc/administration/auth/img/crowd_application.png

(limited to 'doc/administration/auth')

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
new file mode 100644
index 00000000000..7deea9dac8e
Binary files /dev/null and b/doc/administration/auth/img/crowd_application.png differ
-- 
cgit v1.2.3