From a899b7ef6538ed9091d3603e99baff6bd61ad37a Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 27 Oct 2015 16:59:24 -0700 Subject: Update Troubleshooting.md --- doc/install/Troubleshooting.md | 5 ----- 1 file changed, 5 deletions(-) (limited to 'doc/install') diff --git a/doc/install/Troubleshooting.md b/doc/install/Troubleshooting.md index 1c00de39a..284303949 100644 --- a/doc/install/Troubleshooting.md +++ b/doc/install/Troubleshooting.md @@ -12,11 +12,6 @@ - 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: -- cgit v1.2.3-1-g7c22 From ede80afe4cce19b4c561f028220ccc21f2581605 Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 27 Oct 2015 17:05:20 -0700 Subject: Update Administration.md --- doc/install/Administration.md | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'doc/install') diff --git a/doc/install/Administration.md b/doc/install/Administration.md index 06151d81f..ee996088c 100644 --- a/doc/install/Administration.md +++ b/doc/install/Administration.md @@ -2,6 +2,13 @@ This document provides instructions for common administrator tasks +#### Important notes + +##### **DO NOT manipulate the Mattermost database** + - In particular, DO NOT delete data from the database, as Mattermost is designed to stop working if data integrity has been compromised. The system is designed to archive content continously and generally assumes data is never deleted. + +### Common 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. -- cgit v1.2.3-1-g7c22 From 87514f34bb8a8957f257b237c367f19ad766e641 Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 27 Oct 2015 17:24:34 -0700 Subject: Update Troubleshooting.md --- doc/install/Troubleshooting.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'doc/install') diff --git a/doc/install/Troubleshooting.md b/doc/install/Troubleshooting.md index 284303949..0414c88c2 100644 --- a/doc/install/Troubleshooting.md +++ b/doc/install/Troubleshooting.md @@ -22,3 +22,6 @@ The following is a list of common error messages and solutions: ###### `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). + +###### `panic: runtime error: invalid memory address or nil pointer dereference` + - This error can occur if you have manually manipulated the Mattermost database, typically with deletions. Mattermost is designed to serve as a searchable archive, and manual manipulation of the database elements compromises integrity and may prevent upgrade. -- cgit v1.2.3-1-g7c22 From 5871452ccb72239e46bbeb52caa13a67cdf76b3f Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 27 Oct 2015 17:29:35 -0700 Subject: Adding "Solution" sections to guide --- doc/install/Troubleshooting.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'doc/install') diff --git a/doc/install/Troubleshooting.md b/doc/install/Troubleshooting.md index 0414c88c2..0df34e4f5 100644 --- a/doc/install/Troubleshooting.md +++ b/doc/install/Troubleshooting.md @@ -17,11 +17,14 @@ 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). +- Message appears in blue bar on team site. +- **Solution:** 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). + - This error may appear when attempt to use a self-signed certificate to setup SSL, which is not yet supported by Mattermost. You + - **Solution:** Set up a load balancer like Ngnix [per production install guide](https://github.com/mattermost/platform/blob/master/doc/install/Production-Ubuntu.md#set-up-nginx-with-ssl-recommended). A ticket exists to [add support for self-signed certificates in future](x509: certificate signed by unknown authority). ###### `panic: runtime error: invalid memory address or nil pointer dereference` - This error can occur if you have manually manipulated the Mattermost database, typically with deletions. Mattermost is designed to serve as a searchable archive, and manual manipulation of the database elements compromises integrity and may prevent upgrade. + - **Solution:** Restore from databse backup created prior to manual database updates, or reinstall the system. -- cgit v1.2.3-1-g7c22 From 570b54bbfc0151724aa10f61ca0beb4d38351cb9 Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 27 Oct 2015 17:29:54 -0700 Subject: Typo fix --- doc/install/Troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/install') diff --git a/doc/install/Troubleshooting.md b/doc/install/Troubleshooting.md index 0df34e4f5..7166f9978 100644 --- a/doc/install/Troubleshooting.md +++ b/doc/install/Troubleshooting.md @@ -27,4 +27,4 @@ The following is a list of common error messages and solutions: ###### `panic: runtime error: invalid memory address or nil pointer dereference` - This error can occur if you have manually manipulated the Mattermost database, typically with deletions. Mattermost is designed to serve as a searchable archive, and manual manipulation of the database elements compromises integrity and may prevent upgrade. - - **Solution:** Restore from databse backup created prior to manual database updates, or reinstall the system. + - **Solution:** Restore from database backup created prior to manual database updates, or reinstall the system. -- cgit v1.2.3-1-g7c22