This will build a container image for an OpenLDAP Server with Fusion Directory Schema's Included. It includes all the functions in the OpenLDAP Image such as Multi-Master Replication, TLS, and other features.
- About
- Maintainer
- Table of Contents
- Installation
- Environment Variables
- Schema Installation
- Maintenance
- Support & Maintenance
- References
- License
Feature limited builds of the image are available on the Github Container Registry and Docker Hub.
To unlock advanced features, one must provide a code to be able to change specific environment variables from defaults. Support the development to gain access to a code.
To get access to the image use your container orchestrator to pull from the following locations:
ghcr.io/nfrastack/container-openldap-fusiondirectory:<branch>-(image_tag)
docker.io/nfrastack/openldap-fusiondirectory:<branch>-(image_tag)
Image tag syntax is:
<image>:<optional tag>
Example:
ghcr.io/nfrastack/container-openldap-fusiondirectory:2.6-1.5-latest or
ghcr.io/nfrastack/container-openldap-fusiondirectory:2.6-1.5-1.0 or
latestwill be the most recent commit- Branch refers to the git branch you are working with and relates to the openldap-fusiondirectory main versiion.
- An otpional
tagmay exist that matches the CHANGELOG - These are the safest. - If there are multiple distribution variations it may include a version - see the registry for availability.
Have a look at the container registries and see what tags are available.
Images are built for amd64 by default, with optional support for arm64 and other architectures.
-
The quickest way to get started is using docker-compose. See the examples folder for a working compose.yml that can be modified for your use.
-
Map persistent storage for access to configuration and data files for backup.
-
Set various environment variables to understand the capabilities of this image.
See the upstream OpenLDAP Image for this information.
| Directory | Description |
|---|---|
| /custom/fusiondirectory | Optional Custom schema files |
This image relies on a customized base image in order to work. Be sure to view the following repositories to understand all the customizable options:
| Image | Description |
|---|---|
| OS Base | Base Image |
| OpenLDAP | OpenLDAP base image |
Below is the complete list of available options that can be used to customize your installation.
- Variables showing an 'x' under the
Advancedcolumn can only be set if the containers advanced functionality is enabled.
| Parameter | Description | Default | Advanced |
|---|---|---|---|
FUSIONDIRECTORY_ADMIN_USER |
Default FD Admin User | fd-admin |
x |
FUSIONDIRECTORY_ADMIN_PASS |
Default FD Admin Password | admin |
x |
ORGANIZATION |
Organization Name | Example Organization |
To install schemas into the LDAP directory, set the appropriate variables in this syntax:
PLUGIN_<pluginname>=TRUE
| Variable | Description | Default |
|---|---|---|
FUSIONDIRECTORY_SCHEMA_CUSTOM_PATH |
Store custom schemas that are not included in the image here to be loaded | /custom/fusiondirectory/schema/ |
Enter inside the container and type plugin list for available plugins.
You must have the appropriate schemas installed before using the plugin within FusionDirectory.
If you'd like to reapply the schemas on container startup change TRUE to FORCE
Recommended Plugins:
| Variable | Description | Value |
|---|---|---|
PLUGIN_AUDIT |
Audit Trail | TRUE |
PLUGIN_DNS |
Manage DNS | TRUE |
PLUGIN_DSA |
System Accounts | TRUE |
PLUGIN_MAIL |
Mail Attributes | TRUE |
PLUGIN_PERSONAL |
Personal Details | TRUE |
PLUGIN_PPOLICY |
Password Policy | TRUE |
PLUGIN_SSH |
Manage SSH Keys | TRUE |
PLUGIN_SYSTEMS |
Systems Management | TRUE |
For debugging and maintenance, bash and sh are available in the container.
- For community help, tips, and community discussions, visit the Discussions board.
- For personalized support or a support agreement, see Nfrastack Support.
- To report bugs, submit a Bug Report. Usage questions will be closed as not-a-bug.
- Feature requests are welcome, but not guaranteed. For prioritized development, consider a support agreement.
- Updates are best-effort, with priority given to active production use and support agreements.
This project is licensed under the MIT License - see the LICENSE file for details.