ValkeyLDAP - Valkey LDAP authentication module

Build Instructions

ValkeyLDAP uses CMake for building the Valkey module.

mkdir build
cmake -S . -B build
cmake --build build --target all

Manual Module Testing

The project has a collection of scripts to start an LDAP and Valkey server using docker-compose to easily test the module.

To start a Valkey CLI shell to test the module commands, run:

./scripts/run_test_cli.sh

The above command will start the LDAP and Valkey servers, and opens the valkey CLI shell. When the shell closes, it also stops the LDAP and Valkey servers.

If you just want to start the LDAP and Valkey server, run:

./scripts/start_valkey_ldap.sh

You can connect to the LDAP server and Valkey server from the localhost address.

To stop the servers, run:

./scripts/stop_valkey_ldap.sh

Automated Unit Tests

The unit tests use the googletest framework and run using CMake test tool:

To run the tests locally do:

ctest --test-dir build