From b9d7e26b16f95189f72e1f5f6372ac458644acbc Mon Sep 17 00:00:00 2001 From: Dave Conroy Date: Mon, 3 May 2021 12:46:33 -0700 Subject: [PATCH] Update README.md --- README.md | 90 +++++++++++++++++++++++-------------- examples/docker-compose.yml | 2 +- 2 files changed, 57 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 95c50ca..b69fa6b 100755 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ # github.com/tiredofit/docker-openldap -[![Docker Pulls](https://img.shields.io/docker/pulls/tiredofit/openldap.svg)](https://hub.docker.com/r/tiredofit/openldap) -[![Docker Stars](https://img.shields.io/docker/stars/tiredofit/openldap.svg)](https://hub.docker.com/r/tiredofit/openldap) -[![Docker Layers](https://images.microbadger.com/badges/image/tiredofit/openldap.svg)](https://microbadger.com/images/tiredofit/openldap) +[![GitHub release](https://img.shields.io/github/v/tag/tiredofit/docker-postfix?style=flat-square)](https://github.com/tiredofit/docker-postfix/releases/latest) +[![Build Status](https://img.shields.io/github/workflow/status/tiredofit/docker-postfix/build?style=flat-square)](https://github.com/tiredofit/docker-postfix/actions?query=workflow%3Abuild) +[![Docker Stars](https://img.shields.io/docker/stars/tiredofit/postfix.svg?style=flat-square&logo=docker)](https://hub.docker.com/r/tiredofit/postfix/) +[![Docker Pulls](https://img.shields.io/docker/pulls/tiredofit/postfix.svg?style=flat-square&logo=docker)](https://hub.docker.com/r/tiredofit/postfix/) +[![Become a sponsor](https://img.shields.io/badge/sponsor-tiredofit-181717.svg?logo=github&style=flat-square)](https://github.com/sponsors/tiredofit) +[![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal&style=flat-square)](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](dave@tiredofit.ca) @@ -53,22 +53,28 @@ 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 @@ -76,18 +82,9 @@ docker pull tiredofit/openldap * 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 diff --git a/examples/docker-compose.yml b/examples/docker-compose.yml index 4558527..18a9a0e 100755 --- a/examples/docker-compose.yml +++ b/examples/docker-compose.yml @@ -1,4 +1,4 @@ -version: '3.7' +version: '2.4' services: openldap-app: