|
|
@@ -4,45 +4,47 @@
|
|
|

|
|
|

|
|
|
|
|
|
-Latest release: 1.2.2 - OpenLDAP 2.4.44 - [Changelog](CHANGELOG.md) | [Docker Hub](https://hub.docker.com/r/osixia/openldap/)
|
|
|
+Latest release: 1.2.3 - OpenLDAP 2.4.47 - [Changelog](CHANGELOG.md) | [Docker Hub](https://hub.docker.com/r/osixia/openldap/)
|
|
|
|
|
|
**A docker image to run OpenLDAP.**
|
|
|
|
|
|
> OpenLDAP website : [www.openldap.org](http://www.openldap.org/)
|
|
|
|
|
|
|
|
|
-- [Contributing](#contributing)
|
|
|
-- [Quick Start](#quick-start)
|
|
|
-- [Beginner Guide](#beginner-guide)
|
|
|
- - [Create new ldap server](#create-new-ldap-server)
|
|
|
- - [Data persistence](#data-persistence)
|
|
|
- - [Edit your server configuration](#)
|
|
|
- - [Use an existing ldap database](#use-an-existing-ldap-database)
|
|
|
- - [Backup](#backup)
|
|
|
- - [Administrate your ldap server](#administrate-your-ldap-server)
|
|
|
- - [TLS](#tls)
|
|
|
- - [Use auto-generated certificate](#use-auto-generated-certificate)
|
|
|
- - [Use your own certificate](#use-your-own-certificate)
|
|
|
- - [Disable TLS](#disable-tls)
|
|
|
- - [Multi master replication](#multi-master-replication)
|
|
|
- - [Fix docker mounted file problems](#fix-docker-mounted-file-problems)
|
|
|
- - [Debug](#debug)
|
|
|
-- [Environment Variables](#environment-variables)
|
|
|
- - [Default.yaml](#defaultyaml)
|
|
|
- - [Default.startup.yaml](#defaultyamlstartup)
|
|
|
- - [Set your own environment variables](#set-your-own-environment-variables)
|
|
|
- - [Use command line argument](#use-command-line-argument)
|
|
|
- - [Link environment file](#link-environment-file)
|
|
|
- - [Make your own image or extend this image](#make-your-own-image-or-extend-this-image)
|
|
|
-- [Advanced User Guide](#advanced-user-guide)
|
|
|
- - [Extend osixia/openldap:1.2.2 image](#extend-osixiaopenldap122-image)
|
|
|
- - [Make your own openldap image](#make-your-own-openldap-image)
|
|
|
- - [Tests](#tests)
|
|
|
- - [Kubernetes](#kubernetes)
|
|
|
- - [Under the hood: osixia/light-baseimage](#under-the-hood-osixialight-baseimage)
|
|
|
-- [Security](#security)
|
|
|
- - [Known security issues](#known-security-issues)
|
|
|
-- [Changelog](#changelog)
|
|
|
+- [osixia/openldap](#osixiaopenldap)
|
|
|
+ - [Contributing](#contributing)
|
|
|
+ - [Quick Start](#quick-start)
|
|
|
+ - [Beginner Guide](#beginner-guide)
|
|
|
+ - [Create new ldap server](#create-new-ldap-server)
|
|
|
+ - [Data persistence](#data-persistence)
|
|
|
+ - [Edit your server configuration](#edit-your-server-configuration)
|
|
|
+ - [Seed ldap database with ldif](#seed-ldap-database-with-ldif)
|
|
|
+ - [Use an existing ldap database](#use-an-existing-ldap-database)
|
|
|
+ - [Backup](#backup)
|
|
|
+ - [Administrate your ldap server](#administrate-your-ldap-server)
|
|
|
+ - [TLS](#tls)
|
|
|
+ - [Use auto-generated certificate](#use-auto-generated-certificate)
|
|
|
+ - [Use your own certificate](#use-your-own-certificate)
|
|
|
+ - [Disable TLS](#disable-tls)
|
|
|
+ - [Multi master replication](#multi-master-replication)
|
|
|
+ - [Fix docker mounted file problems](#fix-docker-mounted-file-problems)
|
|
|
+ - [Debug](#debug)
|
|
|
+ - [Environment Variables](#environment-variables)
|
|
|
+ - [Default.yaml](#defaultyaml)
|
|
|
+ - [Default.startup.yaml](#defaultstartupyaml)
|
|
|
+ - [Set your own environment variables](#set-your-own-environment-variables)
|
|
|
+ - [Use command line argument](#use-command-line-argument)
|
|
|
+ - [Link environment file](#link-environment-file)
|
|
|
+ - [Make your own image or extend this image](#make-your-own-image-or-extend-this-image)
|
|
|
+ - [Advanced User Guide](#advanced-user-guide)
|
|
|
+ - [Extend osixia/openldap:1.2.3 image](#extend-osixiaopenldap123-image)
|
|
|
+ - [Make your own openldap image](#make-your-own-openldap-image)
|
|
|
+ - [Tests](#tests)
|
|
|
+ - [Kubernetes](#kubernetes)
|
|
|
+ - [Under the hood: osixia/light-baseimage](#under-the-hood-osixialight-baseimage)
|
|
|
+ - [Security](#security)
|
|
|
+ - [Known security issues](#known-security-issues)
|
|
|
+ - [Changelog](#changelog)
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
@@ -55,11 +57,11 @@ If you find this image useful here's how you can help:
|
|
|
## Quick Start
|
|
|
Run OpenLDAP docker image:
|
|
|
|
|
|
- docker run --name my-openldap-container --detach osixia/openldap:1.2.2
|
|
|
+ docker run --name my-openldap-container --detach osixia/openldap:1.2.3
|
|
|
|
|
|
-Do not forget to add the port mapping for both port 389 and 689 if you wish to access the ldap server from another machine.
|
|
|
+Do not forget to add the port mapping for both port 389 and 636 if you wish to access the ldap server from another machine.
|
|
|
|
|
|
- docker run -p 389:389 -p 689:689 --name my-openldap-container --detach osixia/openldap:1.2.2
|
|
|
+ docker run -p 389:389 -p 636:636 --name my-openldap-container --detach osixia/openldap:1.2.3
|
|
|
|
|
|
Either command starts a new container with OpenLDAP running inside. Let's make the first search in our LDAP container:
|
|
|
|
|
|
@@ -95,7 +97,7 @@ It will create an empty ldap for the company **Example Inc.** and the domain **e
|
|
|
By default the admin has the password **admin**. All those default settings can be changed at the docker command line, for example:
|
|
|
|
|
|
docker run --env LDAP_ORGANISATION="My Company" --env LDAP_DOMAIN="my-company.com" \
|
|
|
- --env LDAP_ADMIN_PASSWORD="JonSn0w" --detach osixia/openldap:1.2.2
|
|
|
+ --env LDAP_ADMIN_PASSWORD="JonSn0w" --detach osixia/openldap:1.2.3
|
|
|
|
|
|
#### Data persistence
|
|
|
|
|
|
@@ -133,6 +135,7 @@ The startup script provides some substitutions in bootstrap ldif files. Followin
|
|
|
|
|
|
- `{{ LDAP_BASE_DN }}`
|
|
|
- `{{ LDAP_BACKEND }}`
|
|
|
+- `{{ LDAP_DOMAIN }}`
|
|
|
- `{{ LDAP_READONLY_USER_USERNAME }}`
|
|
|
- `{{ LDAP_READONLY_USER_PASSWORD_ENCRYPTED }}`
|
|
|
|
|
|
@@ -145,12 +148,12 @@ argument to entrypoint if you don't want to overwrite them.
|
|
|
# single file example:
|
|
|
docker run \
|
|
|
--volume ./bootstrap.ldif:/container/service/slapd/assets/config/bootstrap/ldif/50-bootstrap.ldif \
|
|
|
- osixia/openldap:1.2.2 --copy-service
|
|
|
+ osixia/openldap:1.2.3 --copy-service
|
|
|
|
|
|
#directory example:
|
|
|
docker run \
|
|
|
--volume ./ldif:/container/service/slapd/assets/config/bootstrap/ldif/custom \
|
|
|
- osixia/openldap:1.2.2 --copy-service
|
|
|
+ osixia/openldap:1.2.3 --copy-service
|
|
|
|
|
|
### Use an existing ldap database
|
|
|
|
|
|
@@ -161,7 +164,7 @@ simply mount this directories as a volume to `/var/lib/ldap` and `/etc/ldap/slap
|
|
|
|
|
|
docker run --volume /data/slapd/database:/var/lib/ldap \
|
|
|
--volume /data/slapd/config:/etc/ldap/slapd.d \
|
|
|
- --detach osixia/openldap:1.2.2
|
|
|
+ --detach osixia/openldap:1.2.3
|
|
|
|
|
|
You can also use data volume containers. Please refer to:
|
|
|
> [https://docs.docker.com/engine/tutorials/dockervolumes/](https://docs.docker.com/engine/tutorials/dockervolumes/)
|
|
|
@@ -181,7 +184,7 @@ If you are looking for a simple solution to administrate your ldap server you ca
|
|
|
#### Use auto-generated certificate
|
|
|
By default, TLS is already configured and enabled, certificate is created using container hostname (it can be set by docker run --hostname option eg: ldap.example.org).
|
|
|
|
|
|
- docker run --hostname ldap.my-company.com --detach osixia/openldap:1.2.2
|
|
|
+ docker run --hostname ldap.my-company.com --detach osixia/openldap:1.2.3
|
|
|
|
|
|
#### Use your own certificate
|
|
|
|
|
|
@@ -191,24 +194,24 @@ You can set your custom certificate at run time, by mounting a directory contain
|
|
|
--env LDAP_TLS_CRT_FILENAME=my-ldap.crt \
|
|
|
--env LDAP_TLS_KEY_FILENAME=my-ldap.key \
|
|
|
--env LDAP_TLS_CA_CRT_FILENAME=the-ca.crt \
|
|
|
- --detach osixia/openldap:1.2.2
|
|
|
+ --detach osixia/openldap:1.2.3
|
|
|
|
|
|
Other solutions are available please refer to the [Advanced User Guide](#advanced-user-guide)
|
|
|
|
|
|
#### Disable TLS
|
|
|
Add --env LDAP_TLS=false to the run command:
|
|
|
|
|
|
- docker run --env LDAP_TLS=false --detach osixia/openldap:1.2.2
|
|
|
+ docker run --env LDAP_TLS=false --detach osixia/openldap:1.2.3
|
|
|
|
|
|
### Multi master replication
|
|
|
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 --hostname ldap.example.org --env LDAP_REPLICATION=true --detach osixia/openldap:1.2.2)
|
|
|
+ LDAP_CID=$(docker run --hostname ldap.example.org --env LDAP_REPLICATION=true --detach osixia/openldap:1.2.3)
|
|
|
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 --hostname ldap2.example.org --env LDAP_REPLICATION=true --detach osixia/openldap:1.2.2)
|
|
|
+ LDAP2_CID=$(docker run --hostname ldap2.example.org --env LDAP_REPLICATION=true --detach osixia/openldap:1.2.3)
|
|
|
LDAP2_IP=$(docker inspect -f "{{ .NetworkSettings.IPAddress }}" $LDAP2_CID)
|
|
|
|
|
|
#Add the pair "ip hostname" to /etc/hosts on each containers,
|
|
|
@@ -244,7 +247,7 @@ You may have some problems with mounted files on some systems. The startup scrip
|
|
|
|
|
|
To fix that run the container with `--copy-service` argument :
|
|
|
|
|
|
- docker run [your options] osixia/openldap:1.2.2 --copy-service
|
|
|
+ docker run [your options] osixia/openldap:1.2.3 --copy-service
|
|
|
|
|
|
### Debug
|
|
|
|
|
|
@@ -253,11 +256,11 @@ Available levels are: `none`, `error`, `warning`, `info`, `debug` and `trace`.
|
|
|
|
|
|
Example command to run the container in `debug` mode:
|
|
|
|
|
|
- docker run --detach osixia/openldap:1.2.2 --loglevel debug
|
|
|
+ docker run --detach osixia/openldap:1.2.3 --loglevel debug
|
|
|
|
|
|
See all command line options:
|
|
|
|
|
|
- docker run osixia/openldap:1.2.2 --help
|
|
|
+ docker run osixia/openldap:1.2.3 --help
|
|
|
|
|
|
|
|
|
## Environment Variables
|
|
|
@@ -300,6 +303,7 @@ TLS options:
|
|
|
- **LDAP_TLS**: Add openldap TLS capabilities. Can't be removed once set to true. 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_DH_PARAM_FILENAME**: Ldap ssl certificate dh param file. Defaults to `dhparam.pem`
|
|
|
- **LDAP_TLS_CA_CRT_FILENAME**: Ldap ssl CA certificate filename. Defaults to `ca.crt`
|
|
|
- **LDAP_TLS_ENFORCE**: Enforce TLS but except ldapi connections. Can't be disabled once set to true. Defaults to `false`.
|
|
|
- **LDAP_TLS_CIPHER_SUITE**: TLS cipher suite. Defaults to `SECURE256:+SECURE128:-VERS-TLS-ALL:+VERS-TLS1.2:-RSA:-DHE-DSS:-CAMELLIA-128-CBC:-CAMELLIA-256-CBC`, based on Red Hat's [TLS hardening guide](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Security_Guide/sec-Hardening_TLS_Configuration.html)
|
|
|
@@ -322,7 +326,7 @@ Replication options:
|
|
|
|
|
|
If you want to set this variable at docker run command add the tag `#PYTHON2BASH:` and convert the yaml in python:
|
|
|
|
|
|
- docker run --env LDAP_REPLICATION_HOSTS="#PYTHON2BASH:['ldap://ldap.example.org','ldap://ldap2.example.org']" --detach osixia/openldap:1.2.2
|
|
|
+ docker run --env LDAP_REPLICATION_HOSTS="#PYTHON2BASH:['ldap://ldap.example.org','ldap://ldap2.example.org']" --detach osixia/openldap:1.2.3
|
|
|
|
|
|
To convert yaml to python online: http://yaml-online-parser.appspot.com/
|
|
|
|
|
|
@@ -342,7 +346,7 @@ Other environment variables:
|
|
|
Environment variables can be set by adding the --env argument in the command line, for example:
|
|
|
|
|
|
docker run --env LDAP_ORGANISATION="My company" --env LDAP_DOMAIN="my-company.com" \
|
|
|
- --env LDAP_ADMIN_PASSWORD="JonSn0w" --detach osixia/openldap:1.2.2
|
|
|
+ --env LDAP_ADMIN_PASSWORD="JonSn0w" --detach osixia/openldap:1.2.3
|
|
|
|
|
|
Be aware that environment variable added in command line will be available at any time
|
|
|
in the container. In this example if someone manage to open a terminal in this container
|
|
|
@@ -353,14 +357,14 @@ he will be able to read the admin password in clear text from environment variab
|
|
|
For example if your environment files **my-env.yaml** and **my-env.startup.yaml** are in /data/ldap/environment
|
|
|
|
|
|
docker run --volume /data/ldap/environment:/container/environment/01-custom \
|
|
|
- --detach osixia/openldap:1.2.2
|
|
|
+ --detach osixia/openldap:1.2.3
|
|
|
|
|
|
Take care to link your environment files folder to `/container/environment/XX-somedir` (with XX < 99 so they will be processed before default environment files) and not directly to `/container/environment` because this directory contains predefined baseimage environment files to fix container environment (INITRD, LANG, LANGUAGE and LC_CTYPE).
|
|
|
|
|
|
Note: the container will try to delete the **\*.startup.yaml** file after the end of startup files so the file will also be deleted on the docker host. To prevent that : use --volume /data/ldap/environment:/container/environment/01-custom**:ro** or set all variables in **\*.yaml** file and don't use **\*.startup.yaml**:
|
|
|
|
|
|
docker run --volume /data/ldap/environment/my-env.yaml:/container/environment/01-custom/env.yaml \
|
|
|
- --detach osixia/openldap:1.2.2
|
|
|
+ --detach osixia/openldap:1.2.3
|
|
|
|
|
|
#### Make your own image or extend this image
|
|
|
|
|
|
@@ -368,13 +372,13 @@ This is the best solution if you have a private registry. Please refer to the [A
|
|
|
|
|
|
## Advanced User Guide
|
|
|
|
|
|
-### Extend osixia/openldap:1.2.2 image
|
|
|
+### Extend osixia/openldap:1.2.3 image
|
|
|
|
|
|
If you need to add your custom TLS certificate, bootstrap config or environment files the easiest way is to extends this image.
|
|
|
|
|
|
Dockerfile example:
|
|
|
|
|
|
- FROM osixia/openldap:1.2.2
|
|
|
+ FROM osixia/openldap:1.2.3
|
|
|
MAINTAINER Your Name <[email protected]>
|
|
|
|
|
|
ADD bootstrap /container/service/slapd/assets/config/bootstrap
|