-
-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
57 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,12 @@ | ||
| # github.com/tiredofit/docker-openldap | ||
|
|
||
| [](https://hub.docker.com/r/tiredofit/openldap) | ||
| [](https://hub.docker.com/r/tiredofit/openldap) | ||
| [](https://microbadger.com/images/tiredofit/openldap) | ||
| [](https://github.com/tiredofit/docker-postfix/releases/latest) | ||
| [](https://github.com/tiredofit/docker-postfix/actions?query=workflow%3Abuild) | ||
| [](https://hub.docker.com/r/tiredofit/postfix/) | ||
| [](https://hub.docker.com/r/tiredofit/postfix/) | ||
| [](https://github.com/sponsors/tiredofit) | ||
| [](https://www.paypal.me/tiredofit) | ||
|
|
||
|
|
||
| ### About | ||
|
|
||
|
|
@@ -21,10 +25,6 @@ Upon starting this image it will give you a ready to run server with many config | |
| * Two Password Checking Modules - check_password.so and ppm.so | ||
| * Zabbix Monitoring templates included | ||
|
|
||
| * This Container uses a [customized Alpine Linux base](https://hub.docker.com/r/tiredofit/alpine) which includes [s6 overlay](https://github.com/just-containers/s6-overlay) enabled for PID 1 Init capabilities, [zabbix-agent](https://zabbix.org) for individual container monitoring, Cron also installed along with other tools (bash,curl, less, logrotate, mariadb-client, nano, vim) for easier management. It also supports sending to external SMTP servers.. | ||
|
|
||
| [Changelog](CHANGELOG.md) | ||
|
|
||
| ### Maintainer | ||
|
|
||
| - [Dave Conroy]([email protected]) | ||
|
|
@@ -53,41 +53,38 @@ Upon starting this image it will give you a ready to run server with many config | |
|
|
||
| ## Prerequisites and Assumptions | ||
|
|
||
| This image has the capability to take advantage of getting TLS certificates autogenerated via the | ||
| [jwilder/nginx-proxy](https://github.com/jwilder/nginx-proxy) and the [Let's Encrypt Proxy Companion @ | ||
| https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion](https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion). | ||
| However, it will run just fine on it's own without it. | ||
|
|
||
| # Dependencies | ||
|
|
||
| None. | ||
| - This image doesn't do much on it's own, you must use a complemenary service to pass messages or data to it via port 783. | ||
|
|
||
| ## Installation | ||
| ### Build from Source | ||
| Clone this repository and build the image with `docker build -t (imagename) .` | ||
|
|
||
| Automated builds of the image are available on [Docker Hub](https://hub.docker.com/r/tiredofit/openldap) and is the recommended method of installation. | ||
| ### Prebuilt Images | ||
| Builds of the image are available on [Docker Hub](https://hub.docker.com/r/tiredofit/openldap) and is the recommended method of installation. | ||
|
|
||
| ```bash | ||
| docker pull tiredofit/openldap | ||
| docker pull tiredofit/openldap:(imagetag) | ||
| ``` | ||
| The following image tags are available along with their taged release based on what's written in the [Changelog](CHANGELOG.md): | ||
|
|
||
| | Version | Container OS | Tag | | ||
| | ------- | ------------ | --------- | | ||
| | latest | Alpine | `:latest` | | ||
|
|
||
| ### Multi Archictecture | ||
| Images are built primarily for `amd64` architecture, and may also include builds for `arm/v6`, `arm/v7`, `arm64` and others. These variants are all unsupported. Consider [sponsoring](https://github.com/sponsors/tiredofit) my work so that I can work with various hardware. To see if this image supports multiple architecures, type `docker manifest (image):(tag)` | ||
|
|
||
| ## Configuration | ||
|
|
||
| ### Quick Start | ||
|
|
||
| * The quickest way to get started is using [docker-compose](https://docs.docker.com/compose/). See the examples folder for a working [docker-compose.yml](examples/docker-compose.yml) that can be modified for development or production use. | ||
|
|
||
| * Set various [environment variables](#environment-variables) to understand the capabilities of this image. | ||
| * Map [persistent storage](#data-volumes) for access to configuration and data files for backup. | ||
| * Map [Network Ports](#networking) to allow external access. | ||
|
|
||
| Start openldap using: | ||
|
|
||
| ```bash | ||
| docker-compose up | ||
| ``` | ||
|
|
||
| * Make [networking ports](#networking) available for public access if necessary | ||
| __NOTE__: Please allow up to 2 minutes for the application to start for the first time if you are generating self signed TLS certificates. | ||
|
|
||
| ## Configuration | ||
|
|
||
| ### Persistent Storage | ||
|
|
||
| The following directories are used for configuration and can be mapped for persistent storage. | ||
|
|
@@ -101,10 +98,17 @@ The following directories are used for configuration and can be mapped for persi | |
| | `/certs/` | Drop TLS Certificates here (or use your own path) | | ||
| | `/data/backup` | Backup Directory | | ||
|
|
||
| ### Environment Varables | ||
| ### Environment Variables | ||
|
|
||
| #### Base Images used | ||
|
|
||
| Along with the Environment Variables from the [Base image](https://hub.docker.com/r/tiredofit/alpine), below is the complete list of | ||
| available options that can be used to customize your installation. | ||
| This image relies on an [Alpine Linux](https://hub.docker.com/r/tiredofit/alpine) or [Debian Linux](https://hub.docker.com/r/tiredofit/debian) base image that relies on an [init system](https://github.com/just-containers/s6-overlay) for added capabilities. Outgoing SMTP capabilities are handlded via `msmtp`. Individual container performance monitoring is performed by [zabbix-agent](https://zabbix.org). Additional tools include: `bash`,`curl`,`less`,`logrotate`,`nano`,`vim`. | ||
|
|
||
| Be sure to view the following repositories to understand all the customizable options: | ||
|
|
||
| | Image | Description | | ||
| | ------------------------------------------------------ | -------------------------------------- | | ||
| | [OS Base](https://github.com/tiredofit/docker-alpine/) | Customized Image based on Alpine Linux | | ||
|
|
||
| #### Required for new setup | ||
|
|
||
|
|
@@ -150,7 +154,6 @@ available options that can be used to customize your installation. | |
|
|
||
| ##### Backing Up to S3 Compatible Services | ||
|
|
||
|
|
||
| If `BACKUP_LOCATION` = `S3` then the following options are used. | ||
|
|
||
| | Variable | Description | Default | | ||
|
|
@@ -243,9 +246,28 @@ The following ports are exposed and available to public interfaces | |
|
|
||
| For debugging and maintenance purposes you may want access the containers shell. | ||
|
|
||
| ```bash | ||
| docker exec -it openldap bash | ||
| ``` | ||
| ``bash | ||
| docker exec -it (whatever your container name is) bash | ||
| `` | ||
| ## Support | ||
|
|
||
| These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community. | ||
| ### Usage | ||
| - The [Discussions board](../../discussions) is a great place for working with the community on tips and tricks of using this image. | ||
| - Consider [sponsoring me](https://github.com/sponsors/tiredofit) personalized support. | ||
| ### Bugfixes | ||
| - Please, submit a [Bug Report](issues/new) if something isn't working as expected. I'll do my best to issue a fix in short order. | ||
|
|
||
| ### Feature Requests | ||
| - Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline. | ||
| - Consider [sponsoring me](https://github.com/sponsors/tiredofit) regarding development of features. | ||
|
|
||
| ### Updates | ||
| - Best effort to track upstream changes, More priority if I am actively using the image in a production environment. | ||
| - Consider [sponsoring me](https://github.com/sponsors/tiredofit) for up to date releases. | ||
|
|
||
| ## License | ||
| MIT. See [LICENSE](LICENSE) for more details. | ||
|
|
||
| ### References | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| version: '3.7' | ||
| version: '2.4' | ||
| services: | ||
|
|
||
| openldap-app: | ||
|
|
||