kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/administration/auth/crowd.md

88 lines
2.6 KiB
Markdown
Raw Normal View History

SSoT for administration/auth docs - Make sure we have type defined in the frontmatter - Add troubleshooting sections where absent - Meaningful intros where absent
2019-07-15 23:31:08 -04:00
---
type: reference
---
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.
2017-03-07 12:58:30 -05:00
# Atlassian Crowd OmniAuth Provider
SSoT for administration/auth docs - Make sure we have type defined in the frontmatter - Add troubleshooting sections where absent - Meaningful intros where absent
2019-07-15 23:31:08 -04:00
Authenticate to GitLab using the Atlassian Crowd OmniAuth provider.
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.
2017-03-07 12:58:30 -05:00
## 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.
Fix whitespace in many administration docs Many code blocks are 4spaced, and they render in GitLab without coloring as a result, even though they are fenced with a language label. If in a list, other items will render as being in a code block too, even if not meant to. This fixes all these issues for many admin docs in /high_availability and /auth (part 1)
2019-07-11 22:06:46 -04:00
![Example Crowd application configuration](img/crowd_application.png)
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.
2017-03-07 12:58:30 -05:00
## Configure GitLab
1. On your GitLab server, open the configuration file.
Fix whitespace in many administration docs Many code blocks are 4spaced, and they render in GitLab without coloring as a result, even though they are fenced with a language label. If in a list, other items will render as being in a code block too, even if not meant to. This fixes all these issues for many admin docs in /high_availability and /auth (part 1)
2019-07-11 22:06:46 -04:00
**Omnibus:**
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.
2017-03-07 12:58:30 -05:00
Fix whitespace in many administration docs Many code blocks are 4spaced, and they render in GitLab without coloring as a result, even though they are fenced with a language label. If in a list, other items will render as being in a code block too, even if not meant to. This fixes all these issues for many admin docs in /high_availability and /auth (part 1)
2019-07-11 22:06:46 -04:00
```sh
sudo editor /etc/gitlab/gitlab.rb
```
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.
2017-03-07 12:58:30 -05:00
Fix whitespace in many administration docs Many code blocks are 4spaced, and they render in GitLab without coloring as a result, even though they are fenced with a language label. If in a list, other items will render as being in a code block too, even if not meant to. This fixes all these issues for many admin docs in /high_availability and /auth (part 1)
2019-07-11 22:06:46 -04:00
**Source:**
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.
2017-03-07 12:58:30 -05:00
Fix whitespace in many administration docs Many code blocks are 4spaced, and they render in GitLab without coloring as a result, even though they are fenced with a language label. If in a list, other items will render as being in a code block too, even if not meant to. This fixes all these issues for many admin docs in /high_availability and /auth (part 1)
2019-07-11 22:06:46 -04:00
```sh
cd /home/git/gitlab
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.
2017-03-07 12:58:30 -05:00
Fix whitespace in many administration docs Many code blocks are 4spaced, and they render in GitLab without coloring as a result, even though they are fenced with a language label. If in a list, other items will render as being in a code block too, even if not meant to. This fixes all these issues for many admin docs in /high_availability and /auth (part 1)
2019-07-11 22:06:46 -04:00
sudo -u git -H editor config/gitlab.yml
```
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.
2017-03-07 12:58:30 -05:00
1. See [Initial OmniAuth Configuration](../../integration/omniauth.md#initial-omniauth-configuration)
for initial settings.
1. Add the provider configuration:
Fix whitespace in many administration docs Many code blocks are 4spaced, and they render in GitLab without coloring as a result, even though they are fenced with a language label. If in a list, other items will render as being in a code block too, even if not meant to. This fixes all these issues for many admin docs in /high_availability and /auth (part 1)
2019-07-11 22:06:46 -04:00
**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' } }
```
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.
2017-03-07 12:58:30 -05:00
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
Resolve "Include the Crowd application permission information on the "Crowd OmniAuth Provider" page"
2018-01-10 13:18:39 -05:00
## Troubleshooting
If you see an error message like the one below when you sign in after Crowd authentication is configured, you may want to consult the Crowd administrator for the Crowd log file to know the exact cause:
```
could not authorize you from Crowd because invalid credentials
```
Please make sure the Crowd users who need to login to GitLab are authorized to [the application](#configure-a-new-crowd-application) in the step of **Authorisation**. This could be verified by try "Authentication test" for Crowd as of 2.11.
Fix whitespace in many administration docs Many code blocks are 4spaced, and they render in GitLab without coloring as a result, even though they are fenced with a language label. If in a list, other items will render as being in a code block too, even if not meant to. This fixes all these issues for many admin docs in /high_availability and /auth (part 1)
2019-07-11 22:06:46 -04:00
![Example Crowd application authorisation configuration](img/crowd_application_authorisation.png)
Copy permalink