diff options
| author |  Joe Banks <[email protected]> | 2024-07-26 19:44:42 +0100 |
|---|---|---|
| committer | Joe Banks <[email protected]> | 2024-07-26 19:44:42 +0100 |
| commit | 455945dcd2de3448f6230e9e24e93cc1a3ddbccb (patch) | |
| tree | e9dc9fd408300af5dc65f10a3d75c56f3f736008 | |
| parent | Move bonsai to new LDAP group in dependencies (diff) | |
Document installing the LDAP group of dependencies and enabling LDAP
| -rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
@@ -1,3 +1,23 @@ # King Arthur King Arthur is the DevOps helper bot for Python Discord. + +## A note on LDAP + +By default, we install `bonsai`, which requires native modules to be installed +such as OpenLDAP. + +> [!IMPORTANT] +> The LDAP cog will not load in development unless the +> `KING_ARTHUR_ENABLE_LDAP` environment variable is set +> to true, to avoid developers having to attempt to set +> up local emulations of the LDAP directory. + +You can ensure you have the prerequisites [here](https://bonsai.readthedocs.io/en/latest/). + +Once you have met these requirements, use the following to install all project +dependencies as well as the LDAP dependencies. + +``` sh +$ poetry install --with ldap +``` |