From 95c464b167a6b1324bb829271b89e88900e278a2 Mon Sep 17 00:00:00 2001 From: it33 Date: Tue, 27 Oct 2015 08:54:24 -0700 Subject: Create Administration.md --- doc/install/Administration.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 doc/install/Administration.md (limited to 'doc/install/Administration.md') 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. -- 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/Administration.md') 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