146 lines
4.5 KiB
Markdown
146 lines
4.5 KiB
Markdown
---
|
|
title: Integrate with Rocket.chat
|
|
sidebar_label: Rocket.chat
|
|
---
|
|
|
|
# Rocket.chat
|
|
|
|
<span class="badge badge--secondary">Support level: Community</span>
|
|
|
|
## What is Rocket.chat
|
|
|
|
> Rocket.Chat is an open-source fully customizable communications platform developed in JavaScript for organizations with high standards of data protection. It is licensed under the MIT License with some other licenses mixed in. See [Rocket.chat GitHub](https://github.com/RocketChat/Rocket.Chat/blob/develop/LICENSE) for licensing information.
|
|
>
|
|
> -- https://github.com/RocketChat/Rocket.Chat
|
|
|
|
:::note
|
|
This is based on authentik 2022.3.1 and Rocket.chat 4.5.1 using the [Docker-Compose install](https://docs.rocket.chat/quick-start/installing-and-updating/rapid-deployment-methods/docker-and-docker-compose/docker-containers). Instructions may differ between versions.
|
|
:::
|
|
|
|
## Preparation
|
|
|
|
The following placeholders will be used:
|
|
|
|
- `rocket.company` is the FQDN of Rocket.chat.
|
|
- `authentik.company` is the FQDN of authentik.
|
|
|
|
### Step 1
|
|
|
|
In authentik, under _Providers_, create an _OAuth2/OpenID Provider_ with these settings:
|
|
|
|
:::note
|
|
Only settings that have been modified from default have been listed.
|
|
:::
|
|
|
|
**Protocol Settings**
|
|
|
|
- Name: RocketChat
|
|
- Client ID: Copy and Save this for Later
|
|
- Client Secret: Copy and Save this for later
|
|
- Redirect URIs/Origins:
|
|
|
|
```
|
|
https://rocket.company/_oauth/authentik
|
|
```
|
|
|
|
|
|
|
|
### Step 2
|
|
|
|
In authentik, under _Applications_, create a new application with these settings:
|
|
|
|
**Application Settings**
|
|
|
|
- Name: Rocket.chat
|
|
- Slug: rocketchat
|
|
- Provider: RocketChat
|
|
- Launch URL:
|
|
|
|
```
|
|
https://rocket.company/_oauth/authentik
|
|
|
|
```
|
|
|
|
|
|
|
|
### Step 3
|
|
|
|
:::note
|
|
Only settings that have been modified from default have been listed.
|
|
|
|
You may have different settings for some of the group and role mapping for advanced configurations. The settings below are the base settings to connect authentik and Rocket.chat.
|
|
:::
|
|
|
|
In Rocket.chat, follow the procedure below:
|
|
|
|
1. Log in as a System Administrator, click on your avatar, and choose _Administration_
|
|
|
|
2. Scroll down and click on _OAuth_
|
|
|
|
3. In the top right corner, click _Add custom oauth_
|
|
|
|
4. Give your new oauth the name of _Authentik_, then click _Send_
|
|
|
|
|
|
|
|
5. Scroll down to the new OAuth application, expand the dropdown, and enter the following settings:
|
|
|
|
- Enable: Turn the radio button to the _on_ position
|
|
- URL: https://authentik.company/application/o
|
|
- Token Path: /token/
|
|
- Token Sent Via: Payload
|
|
- Identity Token Sent Via: Same as "Token Sent Via"
|
|
- Identity Path: /userinfo/
|
|
- Authorize Path: /authorize/
|
|
- Scope: email profile openid
|
|
- Param Name for access token: access_token
|
|
- Id: _THIS IS THE CLIENT ID YOU COPIED FROM STEP 1 in authentik_
|
|
- Secret: _THIS IS THE CLIENT SECRET YOU COPIED FROM STEP 1 in authentik_
|
|
- Login Style: Redirect
|
|
- Button Text: _Fill in with what you want the SSO button to say_
|
|
- Button Text Color: _Hex Color for Text on the SSO login button_
|
|
- Button Color: _Hex Color for the SSO login button_
|
|
- Key Field: Username
|
|
- Username field: preferred_username
|
|
- Email field: email
|
|
- Name field: name
|
|
- Roles/Groups field name: groups
|
|
- Roles/Groups field for channel mapping: groups
|
|
- User Data Group Map: rocket.cat
|
|
- Merge users: Turn the radio button to the _on_ position
|
|
- Show Button on Login Page: Turn the radio button to the _on_ position
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
6. Click _Save changes_ in the top right corner of the screen
|
|
|
|
### Step 4 (Optional)
|
|
|
|
:::note
|
|
By default, Rocket.chat will attempt to use two-factor authentication with any new user coming in to the system and allows users to change their information
|
|
:::
|
|
|
|
**To disable changing user information and other options inside Rocket.chat:**
|
|
|
|
Navigate to the _Accounts_ settings to change the following:
|
|
|
|
- Allow Name Change: Off
|
|
- Allow Username Change: Off
|
|
- Allow Email Change: Off
|
|
- Allow Password Change for OAuth Users: Off
|
|
|
|
**If you are using Two Factor authentication through authentik:**
|
|
|
|
Navigate to the _Accounts_ settings, Scroll Down to Two Factor Authentication and turn off _Enable Two Factor Authentication_
|
|
|
|
**Registration Options**
|
|
Navigate to the _Accounts_ settings, Scroll Down to Registration and choose your [registration options](https://docs.rocket.chat/guides/administration/settings/account-settings#registration), such as:
|
|
|
|
- Registration Form: Disabled
|