ldap-proxy is implemented as a twistd plugin.

It is recommended to install ldap-proxy inside a virtualenv.

virtualenv2 venv
. ./venv/bin/activate
pip install -r requirements.txt
pip install .

If you wish to develop ldap-proxy, you could instead install it in "editable mode" using

pip install -e .

ldap-proxy is configured via a configuration file. See example-proxy.ini as an example.

ldap-proxy can be run in the foreground as follows:

twistd -n ldap-proxy -c config.ini

twistd can be used to configure, e.g., logging and daemonizing. Refer to its documentation for more information.

deploy/ contains an exemplary systemd service file.

Unit tests are implemented using Trial, which is part of Twisted. They can be run using:

trial pi_ldapproxy.test

There are also a number of client-side scenarios implemented in the scenarios/ directory.