cas.md 1.64 KB
Newer Older
Gabriel Engel's avatar
Gabriel Engel committed
1
# CAS
2

3
Central Authentication Service (CAS) allows users to use one set of credentials to sign into many sites over many different protocols.
4

5
Rocket.Chat includes a CAS plugin that allows you to use your existing CAS server for user authentication.
harish-myaccount's avatar
harish-myaccount committed
6

7
For more information on CAS, see [github.com/apereo/cas](https://github.com/apereo/cas).
adam waring's avatar
adam waring committed
8

9
## Rocket.Chat CAS Administration
10

11
These settings are in the `CAS` settings page under `Administration`:
12

13
1. Visit https://my.rocket.chat.url/admin/CAS
adam waring's avatar
adam waring committed
14

15
or
16

17
18
19
20
1. Log into your Rocket.Chat instance as a user with administrator privileges.
2. Click the "Options" button (3 dots at the top left of the screen)
3. Click the "Administration" link that drops down. (If you do not see one of these links, you are not logged in as a user with enough privileges. Log out and back in with an admin user.)
3. Click the "CAS" link on the left side of the administration section.
adam waring's avatar
adam waring committed
21

22
Your Rocket.Chat instance is the *CAS client*. You must provide a compatible *CAS Server*.
23

24
Once you know your CAS server's URL, enter it into the Rocket.Chat CAS Administration page:
adam waring's avatar
adam waring committed
25

26
27
28
- **SSO Base URL**: `https://<<CAS_server_url>>/cas`
- **SSO Login URL**: `https://<<CAS_server_url>>/cas/login`
- **CAS Version**: `(1.0|2.0)`
29

30
31
32
33
34
35
36
37
38
The `/cas` and `/cas/login` URLs are the standard, but not required. Check with your CAS server provider if the defaults do not work.

The **CAS Version** must be matched to the *CAS Server* provider. Most modern providers will use `CAS 2.0`.


# Notes

1. CAS by ja-sig requires ssl/tls for all connections.
2. Any Drupal 7 or 8 site can serve as a compatible CAS Server. See [drupal.org/project/cas](https://www.drupal.org/project/cas).