A docker image to run OpenLDAP.
Fork of Nick Stenning docker-slapd : https://github.com/nickstenning/docker-slapd
Add support of TLS, multi master replication and easy bootstrap.
Run OpenLDAP docker image :
docker run -d osixia/openldap
This start a new container with a OpenLDAP server running inside.
The odd string printed by this command is the CONTAINER_ID.
We are going to use this CONTAINER_ID to execute some commands inside the container.
Then run a terminal on this container,
make sure to replace CONTAINER_ID by your container id :
docker exec -it CONTAINER_ID bash
You should now be in the container terminal, and we can search on the ldap server :
ldapsearch -x -h localhost -b dc=example,dc=org -D "cn=admin,dc=example,dc=org" -w admin
This should output :
# extended LDIF
#
# LDAPv3
# base <dc=example,dc=org> with scope subtree
# filter: (objectclass=*)
# requesting: ALL
#
[...]
# numResponses: 3
# numEntries: 2
if you have the following error, OpenLDAP is not started yet, wait some time.
ldap_sasl_bind(SIMPLE): Can't contact LDAP server (-1)
This is the default behaviour when you run the image. It will create an empty ldap for the compagny Example Inc. and the domain example.org.
By default the admin has the password admin. All those default settings can be changed at the docker command line, for example :
docker run -e LDAP_ORGANISATION="My Compagny" -e LDAP_DOMAIN="my-compagny.com" \
-e LDAP_ADMIN_PASSWORD="JonSn0w" -d osixia/openldap
The directories /var/lib/ldap (LDAP database files) and /etc/ldap/slapd.d (LDAP config files) has been declared as volumes, so your ldap files are saved outside the container in data volumes.
For more information about docker data volume, please refer to :
This can be achieved by mounting host directories as volume.
Assuming you have a LDAP database on your docker host in the directory /data/slapd/database
and the corresponding LDAP config files on your docker host in the directory /data/slapd/config
simply mount this directories as a volume to /var/lib/ldap and /etc/ldap/slapd.d:
docker run -v /data/slapd/database:/var/lib/ldap \
-v /data/slapd/config:/etc/ldap/slapd.d
-d osixia/openldap
You can also use data volume containers. Please refer to :
By default TLS is enable, a certificate is created with the container hostname (it can be set by docker run -h option eg: ldap.example.org).
docker run -h ldap.my-compagny.com -d osixia/openldap
#### Use your own certificate
Add your custom certificate, private key and CA certificate in the directory image/service/slapd/assets/certs adjust filename in image/env.yaml and rebuild the image (see manual build).
Or you can set your custom certificate at run time, by mouting a directory containing thoses files to /container/service/slapd/assets/certs and adjust there name with the following environment variables :
docker run -h ldap.example.org -v /path/to/certifates:/container/service/slapd/assets/certs \
-e LDAP_TLS_CRT_FILENAME=my-ldap.crt \
-e LDAP_TLS_KEY_FILENAME=my-ldap.key \
-e LDAP_TLS_CA_CRT_FILENAME=the-ca.crt \
-d osixia/openldap
Add -e LDAP_TLS=false to the run command :
docker run -e LDAP_TLS=false -d osixia/openldap
Quick example, with the default config.
#Create the first ldap server, save the container id in LDAP_CID and get its IP:
LDAP_CID=$(docker run -h ldap.example.org -e LDAP_REPLICATION=true -d osixia/openldap)
LDAP_IP=$(docker inspect -f "{{ .NetworkSettings.IPAddress }}" $LDAP_CID)
#Create the second ldap server, save the container id in LDAP2_CID and get its IP:
LDAP2_CID=$(docker run -h ldap2.example.org -e LDAP_REPLICATION=true -d osixia/openldap)
LDAP2_IP=$(docker inspect -f "{{ .NetworkSettings.IPAddress }}" $LDAP2_CID)
#Add the pair "ip hostname" to /etc/hosts on each containers,
#beacause ldap.example.org and ldap2.example.org are fake hostnames
docker exec $LDAP_CID bash -c "echo $LDAP2_IP ldap2.example.org >> /etc/hosts"
docker exec $LDAP2_CID bash -c "echo $LDAP_IP ldap.example.org >> /etc/hosts"
That's it ! But a litle test to be sure :
Add a new user "billy" on the first ldap server
docker exec $LDAP_CID ldapadd -x -D "cn=admin,dc=example,dc=org" -w admin -f /container/service/slapd/assets/test/new-user.ldif -h ldap.example.org -ZZ
Search on the second ldap server, and billy should show up !
docker exec $LDAP2_CID ldapsearch -x -h ldap2.example.org -b dc=example,dc=org -D "cn=admin,dc=example,dc=org" -w admin -ZZ
[...]
# billy, example.org
dn: uid=billy,dc=example,dc=org
uid: billy
cn: billy
sn: 3
objectClass: top
objectClass: posixAccount
objectClass: inetOrgPerson
[...]
If you are looking for a simple solution to administrate your ldap server you can take a look at our phpLDAPadmin docker image :
A simple solution to backup your ldap server, our openldap-backup docker image :
Environement variables defaults are set in image/env.yaml. You can modify environment variable values directly in this file and rebuild the image (see manual build). You can also override those values at run time with -e argument or by setting your own env.yaml file as a docker volume to /etc/env.yaml. See examples below.
General container configuration :
- LDAP_LOG_LEVEL: Slap log level. defaults to
256. See table 5.1 in http://www.openldap.org/doc/admin24/slapdconf2.html for the available log levels.
Required and used for new ldap server only :
-
LDAP_ORGANISATION: Organisation name. Defaults to
Example Inc. -
LDAP_DOMAIN: Ldap domain. Defaults to
example.org -
LDAP_ADMIN_PASSWORD Ldap Admin password. Defaults to
admin -
LDAP_CONFIG_PASSWORD Ldap Config password. Defaults to
config -
LDAP_READONLY_USER Add a read only user. Defaults to
false -
LDAP_READONLY_USER_USERNAME Read only user username. Defaults to
readonly -
LDAP_READONLY_USER_PASSWORD Read only user password. Defaults to
readonly
TLS options :
- LDAP_TLS: Add openldap TLS capabilities. Defaults to
true - LDAP_TLS_CRT_FILENAME: Ldap ssl certificate filename. Defaults to
ldap.crt - LDAP_TLS_KEY_FILENAME: Ldap ssl certificate private key filename. Defaults to
ldap.key - LDAP_TLS_CA_CRT_FILENAME: Ldap ssl CA certificate filename. Defaults to
ca.crt
Replication options :
-
LDAP_REPLICATION: Add openldap replication capabilities. Defaults to
false -
LDAP_REPLICATION_CONFIG_SYNCPROV: olcSyncRepl options used for the config database. Without rid and provider which are automaticaly added based on LDAP_REPLICATION_HOSTS. Defaults to
binddn="cn=admin,cn=config" bindmethod=simple credentials=$LDAP_CONFIG_PASSWORD searchbase="cn=config" type=refreshAndPersist retry="5 5 300 5" timeout=1 starttls=critical -
LDAP_REPLICATION_HDB_SYNCPROV: olcSyncRepl options used for the HDB database. Without rid and provider which are automaticaly added based on LDAP_REPLICATION_HOSTS. Defaults to
binddn="cn=admin,$LDAP_BASE_DN" bindmethod=simple credentials=$LDAP_ADMIN_PASSWORD searchbase="$LDAP_BASE_DN" type=refreshAndPersist interval=00:00:00:10 retry="5 5 300 5" timeout=1 starttls=critical -
LDAP_REPLICATION_HOSTS: list of replication hosts, must contains the current container hostname set by -h on docker run command. Defaults to
['ldap://ldap.example.org', 'ldap://ldap2.example.org']
Environment variable can be set directly by adding the -e argument in the command line, for example :
docker run -e LDAP_ORGANISATION="My Compagny" -e LDAP_DOMAIN="my-compagny.com" \
-e LDAP_ADMIN_PASSWORD="JonSn0w" -d osixia/openldap
Or by setting your own env.yaml file as a docker volume to /etc/env.yaml
docker run -v /data/my-env.yaml:/etc/env.yaml \
-d osixia/openldap
Clone this project :
git clone https://github.com/osixia/docker-openldap
cd docker-openldap
Adapt Makefile, set your image NAME and VERSION, for example :
NAME = osixia/openldap
VERSION = 1.0.0
becomes :
NAME = billy-the-king/openldap
VERSION = 0.1.0
Build your image :
make build
Run your image :
docker run -d billy-the-king/openldap:0.1.0
We use Bats (Bash Automated Testing System) to test this image:
Install Bats, and in this project directory run :
make test