33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# Lumi2 (LDAP user management interface)
|
|
|
|
**Lumi2** is a web application for managing users and user groups present on an OpenLDAP server.
|
|
It provides a web-interface for administrators to create/read/update/delete organization users and user groups, and to allow basic account self-service for organization members themselves.
|
|
Lumi is written in Python, using the [Flask](https://flask.palletsprojects.com/en/latest/) web framework.
|
|
|
|
The motivation for Lumi is for it to provide a more user-friendly interface than [PhpLdapAdmin](https://phpldapadmin.sourceforge.net/wiki/index.php/Main_Page), however it is not a replacement.
|
|
|
|
# Documentation
|
|
|
|
The following frameworks and/or libraries are used:
|
|
|
|
- Backend:
|
|
- [Flask](https://flask.palletsprojects.com/en/2.2.x/)
|
|
- [WTForms](https://wtforms.readthedocs.io/en/3.0.x/)
|
|
- [FlaskWTF](https://flask-wtf.readthedocs.io/en/1.0.x/)
|
|
- [flask-restful](https://flask-restful.readthedocs.io/en/latest/quickstart.html)
|
|
- Frontend:
|
|
- [Bootstrap 5](https://getbootstrap.com/docs/5.2/getting-started/introduction/)
|
|
- [Bootstrap Icons](https://icons.getbootstrap.com/)
|
|
- [jQuery](https://api.jquery.com/)
|
|
- [jQuery tablesorter plugin](https://mottie.github.io/tablesorter/docs/)
|
|
|
|
# Testing
|
|
|
|
Make sure all dependencies listed in `requirements.txt` are installed.
|
|
To run all unit tests, simply run the following from within the repository root:
|
|
|
|
```bash
|
|
coverage run -m pytest && coverage report
|
|
```
|
|
|
|
This will run all unit tests and display the test coverage in your terminal.
|