canaille-globuzma/demo
2022-12-11 14:43:21 +01:00
..
client unit tests: authorization denial 2022-12-11 14:43:21 +01:00
conf Demo displays user preferred locale 2022-12-04 11:53:37 +01:00
conf-docker Demo displays user preferred locale 2022-12-04 11:53:37 +01:00
ldif unit tests: slapd initialization refactoring 2022-12-06 18:18:27 +01:00
.gitignore Development environment without docker. Plus client samples. Fixes #18 2020-11-10 17:52:52 +01:00
docker-compose.yml unit tests: slapd initialization refactoring 2022-12-06 18:18:27 +01:00
Dockerfile-canaille The demo now uses poetry 2022-05-13 16:47:48 +02:00
Dockerfile-client The demo now uses poetry 2022-05-13 16:47:48 +02:00
ldap-server.py unit tests: slapd initialization refactoring 2022-12-06 18:18:27 +01:00
Procfile Stop using the deprecated FLASK_ENV environment variable 2022-11-01 12:56:07 +01:00
README.md make demo entirely runnable with docker-compose 2022-03-18 17:44:58 +01:00
run.sh The demo now uses poetry 2022-05-13 16:47:48 +02:00
slapd.sh The demo now uses poetry 2022-05-13 16:47:48 +02:00

Demo and development

To check out how canaille looks like, or to start contributions, just run the demo:

  • with docker-compose up to install and run it in preconfigured docker containers
  • or with ./run.sh to install it natively in a virtual environment and run it locally!

Prerequisites for native demo installation

You need to have OpenLDAP somewhere in your system.

You can either:

  • install it with your distro packages (for instance sudo apt install slapd ldap-utils with Ubuntu). it is not required to launch the system ldap service.
  • have docker plus docker-compose installed on your system, the ./run.sh script will download and run an OpenLDAP image.

canaille depends on python-ldap, and this package needs some headers to be installed on your system to be built. For instance on Ubuntu you can install this: sudo apt install libsasl2-dev python-dev libldap2-dev libssl-dev. More info on this SO ticket.

Apparmor

On Ubuntu systems, apparmor prevents slapd from accessing files that are not in the standard OpenLDAP installation. This may result in canaille being impossible to launch. To fix this you can pass slapd in complain mode:

sudo apt install --yes apparmor-utils
sudo aa-complain /usr/sbin/slapd

Run the demo

Then you have access to:

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.
  • A new user which login is james. This user has no password yet, and his first attempt to log-in would result in sending a password initialization email (if a smtp server is configurated).