1
0
Fork 0
mirror of https://github.com/iiab/iiab.git synced 2025-02-13 11:42:08 +00:00

Merge pull request #1357 from holta/lokole-docs

roles/lokole/README.rst readability improvements
This commit is contained in:
A Holt 2019-01-03 18:17:35 -05:00 committed by GitHub
commit d511ea5eb1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2,7 +2,7 @@
Lokole README
=============
This Ansible role installs the `Lokole web app <https://github.com/ascoderu/opwen-webapp>`_ within Internet-in-a-Box. Lokole is a project by the Canadian-Congolese non-profit `Ascoderu <https://ascoderu.ca>`_.
This Ansible role installs the `Lokole web app <https://github.com/ascoderu/opwen-webapp>`_ within Internet-in-a-Box (IIAB). Lokole is a project by the Canadian-Congolese non-profit `Ascoderu <https://ascoderu.ca>`_.
The Lokole is a simple email client that offers functionality like:
@ -14,12 +14,14 @@ The Lokole is a simple email client that offers functionality like:
Using It
--------
The Lokole web app can be accessed 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 ``changeme``.
Log in with admin account: ``Admin``
By default, the password is: ``changeme``
Administrators can:
@ -27,17 +29,17 @@ Administrators can:
- 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.
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.
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.
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -66,4 +68,4 @@ TODO
Known Issues
------------
For an up-to-date list of open issues, please see the `Lokole project's issue tracker <https://github.com/ascoderu/opwen-webapp/issues>`_.
For an up-to-date list of open issues, please see the `Lokole project's issue tracker <https://github.com/ascoderu/opwen-webapp/issues>`_. See also `IIAB's issue tracker <https://github.com/iiab/iiab/issues>`_.