2020-10-29 15:09:12 +00:00
---
2020-11-27 18:09:52 +00:00
stage: Create
group: Ecosystem
2020-11-26 06:09:20 +00:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-10-29 15:09:12 +00:00
---
2015-11-12 04:25:31 +00:00
# CAS OmniAuth Provider
2020-11-20 03:09:15 +00:00
To enable the CAS OmniAuth provider you must register your application with your CAS instance. This requires the service URL GitLab supplies to CAS. It should be something like: `https://gitlab.example.com:443/users/auth/cas3/callback?url` . By default handling for SLO is enabled, you only need to configure CAS for backchannel logout.
2015-11-12 04:25:31 +00:00
2019-07-11 15:21:26 +00:00
1. On your GitLab server, open the configuration file.
2015-11-12 04:25:31 +00:00
2019-08-27 08:41:50 +00:00
For Omnibus package:
2015-11-12 04:25:31 +00:00
2020-01-30 15:09:15 +00:00
```shell
2019-07-11 15:21:26 +00:00
sudo editor /etc/gitlab/gitlab.rb
```
2015-11-12 04:25:31 +00:00
2019-07-11 15:21:26 +00:00
For installations from source:
2015-11-12 04:25:31 +00:00
2020-01-30 15:09:15 +00:00
```shell
2019-07-11 15:21:26 +00:00
cd /home/git/gitlab
2015-11-12 04:25:31 +00:00
2019-07-11 15:21:26 +00:00
sudo -u git -H editor config/gitlab.yml
```
2015-11-12 04:25:31 +00:00
2019-07-11 15:21:26 +00:00
1. See [Initial OmniAuth Configuration ](omniauth.md#initial-omniauth-configuration ) for initial settings.
2015-11-12 04:25:31 +00:00
2019-07-11 15:21:26 +00:00
1. Add the provider configuration:
2015-11-12 04:25:31 +00:00
2019-08-27 08:41:50 +00:00
For Omnibus package:
2015-11-12 04:25:31 +00:00
2019-07-11 15:21:26 +00:00
```ruby
gitlab_rails['omniauth_providers'] = [
{
"name"=> "cas3",
"label"=> "cas",
"args"=> {
"url"=> 'CAS_SERVER',
"login_url"=> '/CAS_PATH/login',
"service_validate_url"=> '/CAS_PATH/p3/serviceValidate',
"logout_url"=> '/CAS_PATH/logout'
}
}
]
```
2015-11-12 04:25:31 +00:00
2019-07-11 15:21:26 +00:00
For installations from source:
2015-11-12 04:25:31 +00:00
2020-03-24 03:09:28 +00:00
```yaml
2019-07-11 15:21:26 +00:00
- { name: 'cas3',
label: 'cas',
args: {
2020-10-02 06:08:27 +00:00
url: 'CAS_SERVER',
login_url: '/CAS_PATH/login',
service_validate_url: '/CAS_PATH/p3/serviceValidate',
logout_url: '/CAS_PATH/logout' } }
2019-07-11 15:21:26 +00:00
```
2015-11-12 04:25:31 +00:00
2019-07-11 15:21:26 +00:00
1. Change 'CAS_PATH' to the root of your CAS instance (ie. `cas` ).
2015-11-12 04:25:31 +00:00
2019-07-11 15:21:26 +00:00
1. If your CAS instance does not use default TGC lifetimes, update the `cas3.session_duration` to at least the current TGC maximum lifetime. To explicitly disable SLO, regardless of CAS settings, set this to 0.
2015-11-12 04:25:31 +00:00
2019-07-11 15:21:26 +00:00
1. Save the configuration file.
2015-11-12 04:25:31 +00:00
2020-04-06 12:10:44 +00:00
1. [Reconfigure ](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure ) or
[restart GitLab ](../administration/restart_gitlab.md#installations-from-source ) for the changes to
take effect if you installed GitLab via Omnibus or from source respectively.
2015-11-12 04:25:31 +00:00
2015-12-21 16:37:55 +00:00
On the sign in page there should now be a CAS tab in the sign in form.