mirror of
				https://github.com/iiab/iiab.git
				synced 2025-03-09 15:40:17 +00:00 
			
		
		
		
	Merge pull request #1305 from aidan-fitz/lokole-docs-2
Expand Lokole documentation
This commit is contained in:
		
						commit
						bcf8340ddf
					
				
					 2 changed files with 49 additions and 2 deletions
				
			
		| 
						 | 
				
			
			@ -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 ``changeme``.
 | 
			
		||||
 | 
			
		||||
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] <username> [--password | -p] <password>
 | 
			
		||||
 | 
			
		||||
(TODO what working directory?)
 | 
			
		||||
 | 
			
		||||
Resetting the Database
 | 
			
		||||
~~~~~~~~~~~~~~~~~~~~~~
 | 
			
		||||
 | 
			
		||||
TODO
 | 
			
		||||
 | 
			
		||||
Troubleshooting
 | 
			
		||||
---------------
 | 
			
		||||
 | 
			
		||||
TODO
 | 
			
		||||
 | 
			
		||||
Known Issues
 | 
			
		||||
------------
 | 
			
		||||
 | 
			
		||||
Please see `#1282 <https://github.com/iiab/iiab/pull/1282#issuecomment-435622419>`_.
 | 
			
		||||
For an up-to-date list of open issues, please see the `Lokole project's issue tracker <https://github.com/ascoderu/opwen-webapp/issues>`_.
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										
											BIN
										
									
								
								roles/lokole/The Lokole-IIAB User's Manual.pdf
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								roles/lokole/The Lokole-IIAB User's Manual.pdf
									
										
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue