diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/guides/auth/mattermost-self-hosted.md | 32 |
1 files changed, 14 insertions, 18 deletions
diff --git a/docs/guides/auth/mattermost-self-hosted.md b/docs/guides/auth/mattermost-self-hosted.md index e3050595..d8280399 100644 --- a/docs/guides/auth/mattermost-self-hosted.md +++ b/docs/guides/auth/mattermost-self-hosted.md @@ -1,33 +1,29 @@ Authentication guide - Mattermost (self-hosted) === -*Note: The Mattermost setup portion of this document is just a quick guide. See the [official documentation](https://docs.mattermost.com/developer/oauth-2-0-applications.html) for more details.* +**Note:** *The Mattermost setup portion of this document is just a quick guide. See the [official documentation](https://docs.mattermost.com/developer/oauth-2-0-applications.html) for more details.* This guide uses the generic OAuth2 module for compatibility with Mattermost version 5.0 and above. 1. Sign-in with an administrator account to your Mattermost instance -2. Make sure **OAuth 2.0 Service Provider** is enabled in the Main Menu (menu button next to your username in the top left corner) --> System Console --> Custom Integrations menu, which you can find at `https://your.mattermost.domain/admin_console/integrations/custom` - - +2. Make sure **OAuth 2.0 Service Provider** is enabled in the Main Menu (menu button next to your username in the top left corner) --> System Console --> Custom Integrations menu, which you can find at `https://your.mattermost.domain/admin_console/integrations/custom` +  3. Navigate to the OAuth integration settings through Main Menu --> Integrations --> OAuth 2.0 Applications, at `https://your.mattermost.domain/yourteam/integrations/oauth2-apps` -4. Click on the **Add OAuth 2.0 Application** button to add a new OAuth application - - +4. Click on the **Add OAuth 2.0 Application** button to add a new OAuth application +  -5. Fill out the form and click **Save** - - +5. Fill out the form and click **Save** +  *Note: The callback URL is \<your-codimd-url\>/auth/oauth2/callback* -6. After saving the application, you'll receive the Client ID and Client Secret - - +6. After saving the application, you'll receive the Client ID and Client Secret +  7. Add the Client ID and Client Secret to your config.json file or pass them as environment variables - * config.json: - ````javascript + * `config.json`: + ```javascript { "production": { "oauth2": { @@ -43,9 +39,9 @@ This guide uses the generic OAuth2 module for compatibility with Mattermost vers } } } - ```` + ``` * environment variables: - ```` + ```sh CMD_OAUTH2_BASEURL=https://your.mattermost.domain CMD_OAUTH2_USER_PROFILE_URL=https://your.mattermost.domain/api/v4/users/me CMD_OAUTH2_USER_PROFILE_USERNAME_ATTR=id @@ -55,4 +51,4 @@ This guide uses the generic OAuth2 module for compatibility with Mattermost vers CMD_OAUTH2_AUTHORIZATION_URL=https://your.mattermost.domain/oauth/authorize CMD_OAUTH2_CLIENT_ID=ii4p1u3jz7dXXXXXXXXXXXXXXX CMD_OAUTH2_CLIENT_SECRET=mqzzx6fydbXXXXXXXXXXXXXXXX - ```` + ``` |