diff --git a/docs/development.md b/docs/development.md index a8db6ccc..8cfa8d48 100644 --- a/docs/development.md +++ b/docs/development.md @@ -77,3 +77,24 @@ destroy-ns # So we don't dirty the git history rm temp.json ``` + +## Mattermost + +### SSO + +If creating totally new users, it's best to have them use the sign-up process in Keycloak to ensure properly configured users. Importing users from +an external system en-masse into the UDS Keycloak is outside the scope of this document. + +When creating users for Mattermost manually in Keycloak, be sure to put a `mattermostid` in for the user. If you don't, when you sign into Mattermost `via GitLab` you'll get the `Could not parse auth data out of gitlab user object` error. + +![image](screenshots/mattermost-sso-missing-mattermostid.png) + +If you create an invalid `mattermostid` (such as entering a person's name) you'll get an invalid OAuth object error. It expects a (unique) string of numbers. + +### Enabling Calls + +The calls plugin starts out in [test mode](https://docs.mattermost.com/configure/plugins-configuration-settings.html#test-mode). Administrators must turn it on if it's desired. + +![image](screenshots/enable-call-plugin.png) + +This is presently a known issue (calls don't work). Review [#73](https://github.com/defenseunicorns/uds-bundle-software-factory-nutanix/issues/73) for updates. diff --git a/docs/screenshots/enable-call-plugin.png b/docs/screenshots/enable-call-plugin.png new file mode 100644 index 00000000..cbbcb58a Binary files /dev/null and b/docs/screenshots/enable-call-plugin.png differ diff --git a/docs/screenshots/mattermost-sso-missing-mattermostid.png b/docs/screenshots/mattermost-sso-missing-mattermostid.png new file mode 100644 index 00000000..43c02e13 Binary files /dev/null and b/docs/screenshots/mattermost-sso-missing-mattermostid.png differ