2020-11-05 11:18:17 +00:00
< div align = "center" >
< img src = "canaille/static/img/canaille-full.png" height = "200" alt = "Canaille" / >
< / div >
2020-08-31 12:10:32 +00:00
2020-11-05 11:18:17 +00:00
**Canaille** is a French word meaning *rascal* . It is roughly pronounced **Can I?** ,
2021-04-30 22:35:47 +00:00
as in *Can I access your data?* Canaille is a simple account manager and an OpenID Connect provider based upon a LDAP database.
2020-08-14 11:21:01 +00:00
2020-08-19 12:13:10 +00:00
It aims to be very light, simple to install and simple to maintain. Its main features are :
2020-11-13 09:56:29 +00:00
- Authentication and user profile edition against a LDAP directory;
2023-08-15 15:20:26 +00:00
- Registration, email confirmation, "I forgot my password" emails;
2021-12-01 10:46:09 +00:00
- Only OpenID Connect: no outdated or exotic protocol support;
- No additional database required: everything is stored in your LDAP server;
2021-10-28 13:24:34 +00:00
- Customizable, themable;
2023-08-15 15:20:26 +00:00
- The code is easy to read and easy to edit!
2020-08-18 15:39:34 +00:00
2020-11-06 10:44:25 +00:00
# Screenshots
2020-08-19 12:01:33 +00:00
2020-11-06 10:44:25 +00:00
< div align = "center" >
2021-01-06 16:45:32 +00:00
< img src = "doc/_static/login.png" width = "225" alt = "Canaille login page" / >
< img src = "doc/_static/profile.png" width = "225" alt = "Canaille profile page" / >
< img src = "doc/_static/consent.png" width = "225" alt = "Canaille consent page" / >
2020-11-06 10:44:25 +00:00
< / div >
2020-10-23 09:31:16 +00:00
2020-11-13 10:15:17 +00:00
# Try it!
```bash
cd demo
2022-03-18 16:44:58 +00:00
./run.sh # or `docker-compose up` to run it with docker
2020-11-13 10:15:17 +00:00
```
2022-07-04 14:05:43 +00:00
or try our [online demo ](https://demo.canaille.yaal.coop )!
You have access to:
- a canaille server at [https://demo.canaille.yaal.coop ](https://demo.canaille.yaal.coop )
- a dummy client at [https://demo.client1.yaal.coop ](https://demo.client1.yaal.coop )
- another dummy client at [https://demo.client2.yaal.coop ](https://demo.client2.yaal.coop )
The canaille server has some default users:
- A regular user which login and password are **user**
- A moderator user which login and password are **moderator**
- An admin user which login and password are **admin**
Online demo data are reset every night at 02:00 CEST.
2020-11-06 10:44:25 +00:00
# Documentation
2020-10-23 09:31:16 +00:00
2021-09-28 10:08:12 +00:00
⚠ Canaille is under heavy development and may not fit a production environment yet. However, [contributions ](CONTRIBUTING.rst ) are welcome! ⚠
2020-08-18 15:39:34 +00:00
2020-11-12 08:30:39 +00:00
- Please have a look on our [documentation ](https://canaille.readthedocs.io );
- To **install** canaille, just follow the [installation guide ](https://canaille.readthedocs.io/en/latest/install.html );
2020-11-13 10:15:17 +00:00
- To **contribute** to canaille, please read the [contribution guide ](https://canaille.readthedocs.io/en/latest/contributing.html ).
2023-02-03 17:06:24 +00:00
## Translation status
2023-08-16 14:30:47 +00:00
< div align = "center" >
[](https://hosted.weblate.org/engage/canaille/?utm_source=widget)
< / div >