summaryrefslogtreecommitdiffstats
path: root/doc/install/Administration.md
diff options
context:
space:
mode:
authorAsaad Mahmood <Unknowngi@live.com>2015-10-28 18:04:27 +0500
committerAsaad Mahmood <Unknowngi@live.com>2015-10-28 18:04:27 +0500
commite104829dcd7ae8ea0d6ab87f341cf5c5f1b30a41 (patch)
tree769e7de1f1c12cc4d58d934709032bc1bcbdedc9 /doc/install/Administration.md
parent179c4ea684af8d2a021cc6f0042bc4408f39b0bb (diff)
parentc6f3361d3caf671ca64b798d5ac9eca97c387f9e (diff)
downloadchat-e104829dcd7ae8ea0d6ab87f341cf5c5f1b30a41.tar.gz
chat-e104829dcd7ae8ea0d6ab87f341cf5c5f1b30a41.tar.bz2
chat-e104829dcd7ae8ea0d6ab87f341cf5c5f1b30a41.zip
Merge branch 'master' of https://github.com/mattermost/platform into ui-improvements
Diffstat (limited to 'doc/install/Administration.md')
-rw-r--r--doc/install/Administration.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/install/Administration.md b/doc/install/Administration.md
new file mode 100644
index 000000000..ee996088c
--- /dev/null
+++ b/doc/install/Administration.md
@@ -0,0 +1,19 @@
+# Administration
+
+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.
+
+##### 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.