From 9b98cb88e51312738b3768df98bb6460594748c0 Mon Sep 17 00:00:00 2001 From: Bertrand <34275174+BertrandGouny@users.noreply.github.com> Date: Sat, 17 Oct 2026 10:15:13 +0200 Subject: [PATCH] docs: pin image examples to 2.6.15-beta --- CHANGELOG.md | 2 + README.md | 38 +++++++++---------- docs/examples/quickstart-compose.yaml | 2 +- docs/examples/replication-compose.yaml | 4 +- .../openldap-bootstrap/assets/ldif/README.md | 2 +- 5 files changed, 25 insertions(+), 23 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b6ab75c..1897dcd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,6 +35,8 @@ Project-specific changes only. See upstream [OpenLDAP release notes](https://www ### Documentation +- Pin documentation commands and Compose examples to `osixia/openldap:2.6.15-beta`. + - Document the Postfix Book schema and its incompatibility with the `virtualMail` schema. - Improve the schema conversion example for local files and non-root execution. - List the schemas and modules available in the image, with their incompatibilities. diff --git a/README.md b/README.md index fd5db78..c629249 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Run a basic OpenLDAP server: docker run --name openldap --hostname ldap.example.org -p 389:3890 -p 636:6360 \ -e OPENLDAP_BOOTSTRAP_ORGANIZATION="Keycloakers Org" \ -e OPENLDAP_BOOTSTRAP_SUFFIX="dc=keycloakers,dc=org" \ - osixia/openldap + osixia/openldap:2.6.15-beta ``` For persistent deployments, mount config, data, and backup directories: @@ -52,7 +52,7 @@ docker run --name openldap --hostname ldap.example.org -p 389:3890 -p 636:6360 \ -v openldap-conf:/etc/openldap/slapd.d \ -v openldap-data:/var/lib/openldap/openldap-data \ -v openldap-backups:/var/lib/openldap/openldap-backups \ - osixia/openldap + osixia/openldap:2.6.15-beta ``` Notes: @@ -87,7 +87,7 @@ The `osixia/openldap` container allows you to pass additional command-line argum Arguments specified after `--` are forwarded to the slapd process inside the container: ``` bash -docker run osixia/openldap -- -d -1 +docker run osixia/openldap:2.6.15-beta -- -d -1 ``` **Customizing bootstrap configuration and data** @@ -103,21 +103,21 @@ The `--log-level debug --bash` options from `osixia/baseimage` enables debug log If OpenLDAP keeps crashing, you can add `--skip-process` to start the container without launching service processes. ``` bash -docker run -it osixia/openldap --log-level debug --bash -docker run -it osixia/openldap --skip-process --log-level debug --bash +docker run -it osixia/openldap:2.6.15-beta --log-level debug --bash +docker run -it osixia/openldap:2.6.15-beta --skip-process --log-level debug --bash ``` You can also increase the OpenLDAP daemon (`slapd`) log level with `OPENLDAP_DEBUG_LEVEL`: ``` bash -docker run -e OPENLDAP_DEBUG_LEVEL=-1 osixia/openldap +docker run -e OPENLDAP_DEBUG_LEVEL=-1 osixia/openldap:2.6.15-beta ``` > `OPENLDAP_DEBUG_LEVEL` only affects OpenLDAP (`slapd`) logging. To increase container/runtime logs, use the baseimage flag `--log-level` (for example `--log-level debug`). To see all available command-line options: ``` bash -docker run --rm osixia/openldap --help # osixia/baseimage options -docker run --rm osixia/openldap -x openldap -- --help # slapd command-line options +docker run --rm osixia/openldap:2.6.15-beta --help # osixia/baseimage options +docker run --rm osixia/openldap:2.6.15-beta -x openldap -- --help # slapd command-line options ``` ## 🛟 Backup / Restore @@ -159,7 +159,7 @@ docker run --name openldap-cron \ -v openldap-conf:/etc/openldap/slapd.d \ -v openldap-data:/var/lib/openldap/openldap-data \ -v openldap-backups:/var/lib/openldap/openldap-backups \ - osixia/openldap -x openldap-cron + osixia/openldap:2.6.15-beta -x openldap-cron ``` See the `OPENLDAP_CRON_JOB` environment variable to adjust the cron schedule and behavior. @@ -180,7 +180,7 @@ The simplest way is to mount a directory that contains files with exactly those docker run --name openldap --hostname ldap.example.org -p 389:3890 -p 636:6360 \ -e OPENLDAP_BOOTSTRAP_TLS=true \ -v $PWD/certs:/container/services/openldap/assets/certs \ - osixia/openldap + osixia/openldap:2.6.15-beta ``` If you also set `OPENLDAP_BOOTSTRAP_TLS_REQUIRED=true`, bootstrap adds TLS-required access rules. That setting is stricter than plain TLS enablement and is intended for deployments where non-TLS client access should be rejected. @@ -209,7 +209,7 @@ docker run --name ldap1 --network openldap-net --hostname ldap1.example.org \ -e OPENLDAP_BOOTSTRAP_REPLICATION=true \ -e OPENLDAP_BOOTSTRAP_REPLICATION_HOSTS="ldap://ldap1.example.org:3890 ldap://ldap2.example.org:3890" \ -e OPENLDAP_BOOTSTRAP_REPLICATION_DATA_READONLY_PASSWORD="passw0rd" \ - osixia/openldap + osixia/openldap:2.6.15-beta ``` Minimal example for `ldap2.example.org`: @@ -222,7 +222,7 @@ docker run --name ldap2 --network openldap-net --hostname ldap2.example.org \ -e OPENLDAP_BOOTSTRAP_REPLICATION=true \ -e OPENLDAP_BOOTSTRAP_REPLICATION_HOSTS="ldap://ldap1.example.org:3890 ldap://ldap2.example.org:3890" \ -e OPENLDAP_BOOTSTRAP_REPLICATION_DATA_READONLY_PASSWORD="passw0rd" \ - osixia/openldap + osixia/openldap:2.6.15-beta ``` If TLS is required for replication, set `OPENLDAP_BOOTSTRAP_REPLICATION_TLS=true` or rely on its default value from `OPENLDAP_BOOTSTRAP_TLS_REQUIRED`. @@ -258,7 +258,7 @@ docker exec openldap container run -- slapcat -n 0 Search for all entries under a base DN: ``` bash -docker run --rm osixia/openldap run -- \ +docker run --rm osixia/openldap:2.6.15-beta run -- \ ldapsearch -H ldap://172.16.0.1 \ -D "cn=admin,dc=example,dc=org" -w passw0rd \ -b "dc=example,dc=org" "(objectClass=*)" @@ -267,7 +267,7 @@ docker run --rm osixia/openldap run -- \ Verify bind credentials: ``` bash -docker run --rm osixia/openldap run -- \ +docker run --rm osixia/openldap:2.6.15-beta run -- \ ldapwhoami -H ldap://172.16.0.1 \ -D "cn=admin,dc=example,dc=org" -w passw0rd ``` @@ -276,7 +276,7 @@ Add entries from a local LDIF file: ``` bash docker run --rm -v /path/to/entries.ldif:/tmp/entries.ldif \ - osixia/openldap run -- \ + osixia/openldap:2.6.15-beta run -- \ ldapadd -H ldap://172.16.0.1 \ -D "cn=admin,dc=example,dc=org" -w passw0rd \ -f /tmp/entries.ldif @@ -285,7 +285,7 @@ docker run --rm -v /path/to/entries.ldif:/tmp/entries.ldif \ Change a user's password: ``` bash -docker run --rm osixia/openldap run -- \ +docker run --rm osixia/openldap:2.6.15-beta run -- \ ldappasswd -H ldap://172.16.0.1 \ -D "cn=admin,dc=example,dc=org" -w passw0rd \ -s newpassword "uid=jdoe,ou=people,dc=example,dc=org" @@ -296,20 +296,20 @@ docker run --rm osixia/openldap run -- \ Generate a random password: ``` bash -docker run --rm osixia/openldap run -- openldap-ctl password generate +docker run --rm osixia/openldap:2.6.15-beta run -- openldap-ctl password generate ``` Hash a password: ``` bash -docker run --rm osixia/openldap run -- openldap-ctl password hash passw0rd +docker run --rm osixia/openldap:2.6.15-beta run -- openldap-ctl password hash passw0rd ``` ### Convert Schema to LDIF ``` bash docker run --rm --user $UID -v $(pwd)/schema:/data \ - osixia/openldap run -- openldap-ctl schema2ldif /data/test.schema + osixia/openldap:2.6.15-beta run -- openldap-ctl schema2ldif /data/test.schema ``` ## 🔤 Environment Variables diff --git a/docs/examples/quickstart-compose.yaml b/docs/examples/quickstart-compose.yaml index ac1425b..a5dcc87 100644 --- a/docs/examples/quickstart-compose.yaml +++ b/docs/examples/quickstart-compose.yaml @@ -1,6 +1,6 @@ services: openldap: - image: osixia/openldap + image: osixia/openldap:2.6.15-beta container_name: openldap ports: - "389:3890" diff --git a/docs/examples/replication-compose.yaml b/docs/examples/replication-compose.yaml index b1d95f5..23e884a 100644 --- a/docs/examples/replication-compose.yaml +++ b/docs/examples/replication-compose.yaml @@ -1,6 +1,6 @@ services: ldap1: - image: osixia/openldap + image: osixia/openldap:2.6.15-beta container_name: ldap1 hostname: ldap1.example.org networks: @@ -21,7 +21,7 @@ services: - ldap1-backups:/var/lib/openldap/openldap-backups ldap2: - image: osixia/openldap + image: osixia/openldap:2.6.15-beta container_name: ldap2 hostname: ldap2.example.org networks: diff --git a/services/openldap-bootstrap/assets/ldif/README.md b/services/openldap-bootstrap/assets/ldif/README.md index c8cd281..887b818 100644 --- a/services/openldap-bootstrap/assets/ldif/README.md +++ b/services/openldap-bootstrap/assets/ldif/README.md @@ -105,7 +105,7 @@ mkdir -p custom-config custom-data docker run --name openldap \ -v "$(pwd)/custom-config:/container/services/openldap-bootstrap/assets/ldif/config/custom" \ -v "$(pwd)/custom-data:/container/services/openldap-bootstrap/assets/ldif/data/custom" \ - osixia/openldap + osixia/openldap:2.6.15-beta ``` Put `.ldif` files in these directories, or use `.ldif.template` files with `${VARIABLE}` placeholders to substitute environment variables. Leave the mounts writable so bootstrap can convert templates into `.ldif` files.