Skip to content
Permalink
3.3.1-20210213
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

comanage-registry-docker/docs/slapd-common-environment-variables.md

Go to file
 
 
Cannot retrieve contributors at this time
Environment Variables Common to All slapd Images Using Files to Inject Secrets Environment Variables
122 lines (94 sloc) 3.9 KB
Raw Blame
Open in GitHub Desktop

Environment Variables Common to All slapd Images

The environment variables detailed below apply to all OpenLDAP slapd for COmanage Registry images in this repository.

Using Files to Inject Secrets

The COmanage Registry images support the convention of an associated environment variable ending with _FILE to indicate a path relative to the container from which the value for an environment variable should be read.

For example if the environment variable OLC_ROOT_DN_PASSWORD_FILE exists and its value is the path to a readable file, then the contents of the file will be read into the environment variable OLC_ROOT_DN_PASSWORD.

If both an environment variable and the associated _FILE environment variable are defined the associated _FILE environment variable takes precedence, provided that the file it points to exists and is readable.

Environment Variables

OLC_ROOT_DN
  • Description: DN for the directory root user
  • Required: yes
  • Default: cn=admin,dc=my,dc=org
  • Example: cn=directoryAdministrator,dc=some,dc=university,dc=org
  • Note: [1]
OLC_ROOT_DN_PASSWORD
  • Description: Unhashed password for the root DN used by the entrypoint script to execute any injected LDIF as the root DN user
  • Required: no
  • Default: none
  • Example: KaVJ1FIH5IrRr6R5LElX
  • Note: The environment variable OLC_ROOT_DN is used to set the hashed password for the root DN during the bootstrapping of the directory. This environment variable is used to inject the unhashed password so that the entrypoint script can execute injected LDIF as the root DN user. If no LDIF is injected that needs to be executed as the root DN than this environment variable is not necessary.
OLC_ROOT_PW
  • Description: Password (usually hashed) for the root DN
  • Required: yes if OLC_ROOT_DN_PASSWORD is not set
  • Default: password
  • Example: {SSHA}emcy1JA+mxbHH0PMPcnasE9apBStAMks
  • Note: See the slappasswd OpenLDAP password utility for details on how to create a hashed password value. See also [1].
OLC_SUFFIX
  • Description: Suffix for the directory
  • Required: yes
  • Default: dc=my,dc=org
  • Example: dc=some,dc=university,dc=edu
  • Note: [1]
SLAPD_CERT_FILE
  • Description: Path inside the container to an X.509 certificate to use for TLS
  • Required: no
  • Default: none
  • Example: /run/secrets/slapd_cert_file
SLAPD_CHAIN_FILE
  • Description: Path inside the container to the certificate authority signing certificate corresponding to the X.509 certificate to use for TLS
  • Required: no
  • Default: none
  • Example: /run/secrets/slapd_chain_file
SLAPD_PRIVKEY_FILE
  • Description: Path inside the container to the private key associated with the X.509 certificate for TLS
  • Required: no
  • Default: none
  • Example: /run/secrets/slapd_privkey_file

[1]: The environment variable is read the first time the container is started and used to bootstrap the directory. Later changes to the environment variable are not reflected in the directory state.