diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/install/Administration.md | 12 | ||||
| -rw-r--r-- | doc/install/Troubleshooting.md | 18 | ||||
| -rw-r--r-- | doc/integrations/webhooks/Incoming-Webhooks.md | 3 |
3 files changed, 29 insertions, 4 deletions
diff --git a/doc/install/Administration.md b/doc/install/Administration.md new file mode 100644 index 000000000..06151d81f --- /dev/null +++ b/doc/install/Administration.md @@ -0,0 +1,12 @@ +# Administration + +This document provides instructions for common administrator tasks + +##### Creating System Administrator account from commandline + - If the System Administrator account becomes unavailable, a person leaving the organization for example, you can set a new system admin from the commandline using `./platform -assign_role -team_name="yourteam" -email="you@example.com" -role="system_admin"`. + - After assigning the role the user needs to log out and log back in before the System Administrator role is applied. + +##### Deactivating a user + + - Team Admin or System Admin can go to **Main Menu** > **Manage Members** > **Make Inactive** to deactivate a user, which removes them from the team. + - To preserve audit history, users are never deleted from the system. It is highly recommended that System Administrators do not attempt to delete users manually from the database, as this may compromise system integrity and ability to upgrade in future. diff --git a/doc/install/Troubleshooting.md b/doc/install/Troubleshooting.md index 46efc61fa..1c00de39a 100644 --- a/doc/install/Troubleshooting.md +++ b/doc/install/Troubleshooting.md @@ -8,10 +8,22 @@ #### Common Issues -##### Error message in logs when attempting to sign-up: `x509: certificate signed by unknown authority` - - This error may appear when attempt to use a self-signed certificate to setup SSL, which is not yet supported by Mattermost. You can resolve this issue by setting up a load balancer like Ngnix. A ticket exists to [add support for self-signed certificates in future](x509: certificate signed by unknown authority). - ##### Lost System Administrator account - If the System Administrator account becomes unavailable, a person leaving the organization for example, you can set a new system admin from the commandline using `./platform -assign_role -team_name="yourteam" -email="you@example.com" -role="system_admin"`. - After assigning the role the user needs to log out and log back in before the System Administrator role is applied. +##### Deactivate a user + + - Team Admin or System Admin can go to **Main Menu** > **Manage Members** > **Make Inactive** to deactivate a user, which removes them from the team. + - To preserve audit history, users are never deleted from the system. It is highly recommended that System Administrators do not attempt to delete users manually from the database, as this may compromise system integrity and ability to upgrade in future. + +#### Error Messages + +The following is a list of common error messages and solutions: + +###### `Please check connection, Mattermost unreachable. If issue persists, ask administrator to check WebSocket port.` +- Message appears in blue bar on team site. Check that [your websocket port is properly configured](https://github.com/mattermost/platform/blob/master/doc/install/Production-Ubuntu.md#set-up-nginx-server). + + +###### `x509: certificate signed by unknown authority` in server logs when attempting to sign-up + - This error may appear when attempt to use a self-signed certificate to setup SSL, which is not yet supported by Mattermost. You can resolve this issue by setting up a load balancer like Ngnix. A ticket exists to [add support for self-signed certificates in future](x509: certificate signed by unknown authority). diff --git a/doc/integrations/webhooks/Incoming-Webhooks.md b/doc/integrations/webhooks/Incoming-Webhooks.md index 1216cb5db..b10b6e342 100644 --- a/doc/integrations/webhooks/Incoming-Webhooks.md +++ b/doc/integrations/webhooks/Incoming-Webhooks.md @@ -90,8 +90,9 @@ As mentioned above, Mattermost makes it easy to take integrations written for Sl To see samples and community contributions, please visit <http://mattermost.org/webhooks>. -#### Limitations +#### Known Issues - The `attachments` payload used in Slack is not yet supported - Overriding of usernames does not yet apply to notifications - Cannot supply `icon_emoji` to override the message icon +- Webhook UI fails when connected to deleted channel |