Bitnami Docker Image for OpenLDAP
In order to unify the approaches followed for Bitnami containers and Bitnami Helm charts, we are moving the different bitnami/bitnami-docker-<container>
repositories to a single monorepo bitnami/containers
. Please follow bitnami/containers to keep you updated about the latest Bitnami images.
More information here: https://blog.bitnami.com/2022/07/new-source-of-truth-bitnami-containers.html
OpenLDAP is the open-source solution for LDAP (Lightweight Directory Access Protocol). It is a protocol used to store and retrieve data from a hierarchical directory structure such as in databases.
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
$ docker run --name openldap bitnami/openldap:latest
$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-openldap/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d
DOCKER_CONTENT_TRUST=1
to verify the integrity of the images.Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.
Dockerfile
linksLearn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.
2.6
, 2.6-debian-11
, 2.6.3
, 2.6.3-debian-11-r3
, latest
(2.6/debian-11/Dockerfile)
2.5
, 2.5-debian-11
, 2.5.13
, 2.5.13-debian-11-r7
(2.5/debian-11/Dockerfile)
Subscribe to project updates by watching the bitnami/openldap GitHub repo.
The recommended way to get the Bitnami OpenLDAP Docker Image is to pull the prebuilt image from the Docker Hub Registry.
$ docker pull bitnami/openldap:latest
To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.
$ docker pull bitnami/openldap:[TAG]
If you wish, you can also build the image yourself.
$ docker build -t bitnami/openldap:latest 'https://github.com/bitnami/bitnami-docker-openldap.git#master:2.6/debian-11'
Using Docker container networking, a different server running inside a container can easily be accessed by your application containers and vice-versa.
Containers attached to the same network can communicate with each other using the container name as the hostname.
In this example, we will use a MariaDB Galera instance that will use a OpenLDAP instance that is running on the same docker network to manage authentication.
$ docker network create my-network --driver bridge
Use the --network <NETWORK>
argument to the docker run
command to attach the container to the my-network
network.
$ docker run --detach --rm --name openldap \
--network my-network \
--env LDAP_ADMIN_USERNAME=admin \
--env LDAP_ADMIN_PASSWORD=adminpassword \
--env LDAP_USERS=customuser \
--env LDAP_PASSWORDS=custompassword \
bitnami/openldap:latest
Use the --network <NETWORK>
argument to the docker run
command to attach the container to the my-network
network.
$ docker run --detach --rm --name mariadb-galera \
--network my-network \
--env MARIADB_ROOT_PASSWORD=root-password \
--env MARIADB_GALERA_MARIABACKUP_PASSWORD=backup-password \
--env MARIADB_USER=customuser \
--env MARIADB_DATABASE=customdatabase \
--env MARIADB_ENABLE_LDAP=yes \
--env LDAP_URI=ldap://openldap:1389 \
--env LDAP_BASE=dc=example,dc=org \
--env LDAP_BIND_DN=cn=admin,dc=example,dc=org \
--env LDAP_BIND_PASSWORD=adminpassword \
bitnami/mariadb-galera:latest
Finally we create a new container instance to launch the MariaDB client and connect to the server created in the previous step:
$ docker run -it --rm --name mariadb-client \
--network my-network \
bitnami/mariadb-galera:latest mysql -h mariadb-galera -u customuser -D customdatabase -pcustompassword
When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new bridge
network named my-network
. In this example we assume that you want to connect to the OpenLDAP server from your own custom application image which is identified in the following snippet by the service name myapp
.
version: '2'
networks:
my-network:
driver: bridge
services:
openldap:
image: bitnami/openldap:2
ports:
- '1389:1389'
- '1636:1636'
environment:
- LDAP_ADMIN_USERNAME=admin
- LDAP_ADMIN_PASSWORD=adminpassword
- LDAP_USERS=user01,user02
- LDAP_PASSWORDS=password1,password2
networks:
- my-network
volumes:
- 'openldap_data:/bitnami/openldap'
myapp:
image: 'YOUR_APPLICATION_IMAGE'
networks:
- my-network
volumes:
openldap_data:
driver: local
IMPORTANT:
- Please update the YOUR_APPLICATION_IMAGE_ placeholder in the above snippet with your application image
- In your application container, use the hostname
openldap
to connect to the OpenLDAP server
Launch the containers using:
$ docker-compose up -d
The Bitnami Docker OpenLDAP can be easily setup with the following environment variables:
LDAP_PORT_NUMBER
: The port OpenLDAP is listening for requests. Default: 1389 (non privileged port)LDAP_ROOT
: LDAP baseDN (or suffix) of the LDAP tree. Default: dc=example,dc=org
LDAP_ADMIN_USERNAME
: LDAP database admin user. Default: admin
LDAP_ADMIN_PASSWORD
: LDAP database admin password. Default: adminpassword
LDAP_ADMIN_PASSWORD_FILE
: Path to a file that contains the LDAP database admin user password. This will override the value specified in LDAP_ADMIN_PASSWORD
. No defaults.LDAP_CONFIG_ADMIN_ENABLED
: Whether to create a configuration admin user. Default: no.LDAP_CONFIG_ADMIN_USERNAME
: LDAP configuration admin user. This is separate from LDAP_ADMIN_USERNAME
. Default: admin.LDAP_CONFIG_ADMIN_PASSWORD
: LDAP configuration admin password. Default: configpassword.LDAP_CONFIG_ADMIN_PASSWORD_FILE
: Path to a file that contains the LDAP configuration admin user password. This will override the value specified in LDAP_CONFIG_ADMIN_PASSWORD
. No defaults.LDAP_USERS
: Comma separated list of LDAP users to create in the default LDAP tree. Default: user01,user02
LDAP_PASSWORDS
: Comma separated list of passwords to use for LDAP users. Default: bitnami1,bitnami2
LDAP_USER_DC
: DC for the users' organizational unit. Default: users
LDAP_GROUP
: Group used to group created users. Default: readers
LDAP_ADD_SCHEMAS
: Whether to add the schemas specified in LDAP_EXTRA_SCHEMAS
. Default: yes
LDAP_EXTRA_SCHEMAS
: Extra schemas to add, among OpenLDAP's distributed schemas. Default: cosine, inetorgperson, nis
LDAP_SKIP_DEFAULT_TREE
: Whether to skip creating the default LDAP tree based on LDAP_USERS
, LDAP_PASSWORDS
, LDAP_USER_DC
and LDAP_GROUP
. Please note that this will not skip the addition of schemas or importing of LDIF files. Default: no
LDAP_CUSTOM_LDIF_DIR
: Location of a directory that contains LDIF files that should be used to bootstrap the database. Only files ending in .ldif
will be used. Default LDAP tree based on the LDAP_USERS
, LDAP_PASSWORDS
, LDAP_USER_DC
and LDAP_GROUP
will be skipped when LDAP_CUSTOM_LDIF_DIR
is used. When using this it will override the usage of LDAP_USERS
, LDAP_PASSWORDS
, LDAP_USER_DC
and LDAP_GROUP
. You should set LDAP_ROOT
to your base to make sure the olcSuffix
configured on the database matches the contents imported from the LDIF files. Default: /ldifs
LDAP_CUSTOM_SCHEMA_FILE
: Location of a custom internal schema file that could not be added as custom ldif file (i.e. containing some structuralObjectClass
). Default is /schema/custom.ldif"LDAP_ULIMIT_NOFILES
: Maximum number of open file descriptors. Default: 1024.LDAP_ALLOW_ANON_BINDING
: Allow anonymous bindings to the LDAP server. Default: yes.LDAP_LOGLEVEL
: Set the loglevel for the OpenLDAP server (see https://www.openldap.org/doc/admin25/slapdconfig.html for possible values). Default: 256.You can bootstrap the contents of your database by putting LDIF files in the directory /ldifs
(or the one you define in LDAP_CUSTOM_LDIF_DIR
). Those may only contain content underneath your base DN (set by LDAP_ROOT
). You can not set configuration for e.g. cn=config
in those files.
Check the official OpenLDAP Configuration Reference for more information about how to configure OpenLDAP.
OpenLDAP clients and servers are capable of using the Transport Layer Security (TLS) framework to provide integrity and confidentiality protections and to support LDAP authentication using the SASL EXTERNAL mechanism. Should you desire to enable this optional feature, you may use the following environment variables to configure the application:
LDAP_ENABLE_TLS
: Whether to enable TLS for traffic or not. Defaults to no
.LDAP_LDAPS_PORT_NUMBER
: Port used for TLS secure traffic. Defaults to 1636
.LDAP_TLS_CERT_FILE
: File containing the certificate file for the TLS traffic. No defaults.LDAP_TLS_KEY_FILE
: File containing the key for certificate. No defaults.LDAP_TLS_CA_FILE
: File containing the CA of the certificate. No defaults.LDAP_TLS_DH_PARAMS_FILE
: File containing the DH parameters. No defaults.This new feature is not mutually exclusive, which means it is possible to listen to both TLS and non-TLS connection simultaneously. To use TLS you can use the URI ldaps://openldap:1636
or use the non-TLS URI forcing ldap to use TLS ldap://openldap:1389 -ZZ
.
Using docker run
$ docker run --name openldap \
-v /path/to/certs:/opt/bitnami/openldap/certs \
-v /path/to/openldap-data-persistence:/bitnami/openldap/ \
-e ALLOW_EMPTY_PASSWORD=yes \
-e LDAP_ENABLE_TLS=yes \
-e LDAP_TLS_CERT_FILE=/opt/bitnami/openldap/certs/openldap.crt \
-e LDAP_TLS_KEY_FILE=/opt/bitnami/openldap/certs/openldap.key \
-e LDAP_TLS_CA_FILE=/opt/bitnami/openldap/certs/openldapCA.crt \
bitnami/openldap:latest
Modifying the docker-compose.yml
file present in this repository:
services:
openldap:
...
environment:
...
- LDAP_ENABLE_TLS=yes
- LDAP_TLS_CERT_FILE=/opt/bitnami/openldap/certs/openldap.crt
- LDAP_TLS_KEY_FILE=/opt/bitnami/openldap/certs/openldap.key
- LDAP_TLS_CA_FILE=/opt/bitnami/openldap/certs/openldapCA.crt
...
volumes:
- /path/to/certs:/opt/bitnami/openldap/certs
- /path/to/openldap-data-persistence:/bitnami/openldap/
...
The Bitnami OpenLDAP image allows you to use your custom scripts to initialize a fresh instance.
The allowed script extension is .sh
, all scripts are executed in alphabetical order and need to reside in /docker-entrypoint-initdb.d/
.
Scripts are executed are after the initilization and before the startup of the OpenLDAP service.
The Bitnami OpenLDAP Docker image sends the container logs to stdout
. To view the logs:
$ docker logs openldap
You can configure the containers logging driver using the --log-driver
option if you wish to consume the container logs differently. In the default configuration docker uses the json-file
driver.
To see the actual output of slapd in the container's logs, set the environment variable BITNAMI_DEBUG=true
. Useful especially to find/debug problems in your configuration that lead to errors so OpenLDAP won't start.
Bitnami provides up-to-date versions of OpenLDAP, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.
$ docker pull bitnami/openldap:latest
Stop the currently running container using the command
$ docker stop openldap
$ docker rm -v openldap
Re-create your container from the new image.
$ docker run --name openldap bitnami/openldap:latest
hdb
to mdb
as recommended. No additional steps should be necessary at upgrade time; the new container version 2.4.59
will initialize using the persisted data.We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.
If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:
docker version
)docker info
Copyright © 2022 Bitnami
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.