From 879fd616afb49f88613ce2f09087f48850199c0d Mon Sep 17 00:00:00 2001 From: Aidan Fitzgerald Date: Mon, 19 Nov 2018 21:24:22 -0500 Subject: [PATCH] Add requested content to lokole readme Per iiab/iiab#1293 --- roles/lokole/README.rst | 51 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 49 insertions(+), 2 deletions(-) diff --git a/roles/lokole/README.rst b/roles/lokole/README.rst index 824202d07..7d47f8a24 100644 --- a/roles/lokole/README.rst +++ b/roles/lokole/README.rst @@ -14,9 +14,56 @@ The Lokole is a simple email client that offers functionality like: Using It -------- -Lokole should be accessible at http://box/lokole +The Lokole web app can be accessed at http://box/lokole. + +Administration +-------------- + +Every Lokole installation has an admin account named ``admin``. By default, the password is ``changeme1``. + +Administrators can: + +- Suspend and reinstate user accounts +- Change passwords of user accounts (TODO: admin accounts too?) +- Promote users to the admin role + +All of these actions can be performed from the page http://box/lokole/users. + +Account Suspension +~~~~~~~~~~~~~~~~~~ + +Administrators have the ability to suspend and reinstate other users' accounts. This functionality is useful for dealing with harassment, cyberbullying, and other forms of abuse. + +Password Changes +~~~~~~~~~~~~~~~~ + +In the event of a data breach, administrators can update a user's password to a random string. The user can then log in using this temporary password and change. This functionality is also useful in the case that a user forgets their password. + +Promoting and Demoting Users +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Admins can grant and revoke admin privileges for other users. + +Creating an Admin Account +~~~~~~~~~~~~~~~~~~~~~~~~~ + +To create a new admin account, run the following command:: + + ./manage.py createadmin [--name | -n] [--password | -p] + +(TODO what working directory?) + +Resetting the Database +~~~~~~~~~~~~~~~~~~~~~~ + +TODO + +Troubleshooting +--------------- + +TODO Known Issues ------------ -Please see `#1282 `_. +For an up-to-date list of open issues, please see the `Lokole project's issue tracker `_.