Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/postfixadmin/docker
Docker Image for PostfixAdmin
https://github.com/postfixadmin/docker
docker php-application postfixadmin
Last synced: 6 days ago
JSON representation
Docker Image for PostfixAdmin
- Host: GitHub
- URL: https://github.com/postfixadmin/docker
- Owner: postfixadmin
- License: gpl-2.0
- Created: 2018-01-18T15:49:41.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-22T13:33:57.000Z (about 1 month ago)
- Last Synced: 2024-12-09T03:36:55.697Z (14 days ago)
- Topics: docker, php-application, postfixadmin
- Language: Shell
- Homepage: https://hub.docker.com/_/postfixadmin
- Size: 128 KB
- Stars: 76
- Watchers: 5
- Forks: 21
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/postfixadmin/docker/actions?query=workflow%3A%22GitHub+CI%22)
[](https://doi-janky.infosiftr.net/job/multiarch/job/amd64/job/postfixadmin)
[](https://doi-janky.infosiftr.net/job/multiarch/job/arm32v5/job/postfixadmin)
[](https://doi-janky.infosiftr.net/job/multiarch/job/arm32v6/job/postfixadmin)
[](https://doi-janky.infosiftr.net/job/multiarch/job/arm32v7/job/postfixadmin)
[](https://doi-janky.infosiftr.net/job/multiarch/job/arm64v8/job/postfixadmin)
[](https://doi-janky.infosiftr.net/job/multiarch/job/i386/job/postfixadmin)
[](https://doi-janky.infosiftr.net/job/multiarch/job/mips64le/job/postfixadmin)
[](https://doi-janky.infosiftr.net/job/multiarch/job/ppc64le/job/postfixadmin)
[](https://doi-janky.infosiftr.net/job/multiarch/job/s390x/job/postfixadmin)
# Building
* Clone this repo ( `git clone https://github.com/postfixadmin/docker.git docker` ) and then run :
* `docker build --pull --rm -t postfixadmin-image ` from within the created directory (where \ is replaced by apache, fpm or fpm-alpine)
## Image Variants
The following variant are currently provided:
### apache
This starts an Apache webserver with PHP, so you can use `postfixadmin` out of the box.
### fpm-alpine
This image has a very small footprint. It is based on Alpine Linux and starts only a PHP FPM process. Use this variant if you already have a seperate webserver.
If you need more tools, that are not available on Alpine Linux, use the `fpm` image instead.
### fpm
This image is based on Debian and starts only a PHP FPM container.
Use this variant if you already have a seperate webserver.
# Running
Some knowledge of Postfixadmin is assumed.
Advanced users will probably want to specify a custom configuration (config.local.php file).
If you're just trying out the software, there's probably no need for a config.local.php file.
## No config.local.php / no existing setup
You have two options :
* Use a default sqlite database, or
* Use an external database (MySQL, PgSQL etc).
You can configure this through the following environment variables when running the docker container.
* POSTFIXADMIN\_DB\_TYPE=... - sqlite, mysqli, pgsql
* POSTFIXADMIN\_DB\_NAME=.... - database name or path to database file (sqlite)
* POSTFIXADMIN\_DB\_USER=... - mysqli/pgsql only (db server user name)
* POSTFIXADMIN\_DB\_HOST=... - hostname for database, default is localhost.
* POSTFIXADMIN\_DB\_PORT=... - port for the database (optional)
* POSTFIXADMIN\_DB\_PASSWORD=... - mysqli/pgsql only (db server user password)
* POSTFIXADMIN_ENCRYPT=... - database password encryption (e.g. md5crypt, SHA512-CRYPT)
* POSTFIXADMIN\_SETUP\_PASSWORD=... - generated from setup.php or `php -r "echo password_hash('mysecretpassword', PASSWORD_DEFAULT);"`
Note: An SQLite database is probably not recommended for production use, but is a quick and easy way to try out the software without dependencies.
Note2: For details about database password encryption please refer to the [postfixadmin hashing documentation](https://github.com/postfixadmin/postfixadmin/blob/postfixadmin_3.3/DOCUMENTS/HASHING.md)
You can also set the postfix host and port.
* POSTFIXADMIN\_SMTP\_SERVER=... - localhost per default
* POSTFIXADMIN\_SMTP\_PORT=... - 25 per default
You can enable DKIM through the following enviroment variables
* POSTFIXADMIN\_DKIM=... - YES/NO
* POSTFIXADMIN\_DKIM\_ALL\_ADMINS=... - YES/NO
### Using Docker secrets
As an alternative to passing sensitive information via environment variables, `_FILE` may be appended to some of the previously listed environment variables, causing the initialization script to load the values for those variables from files present in the container. In particular, this can be used to load passwords from Docker secrets stored in /run/secrets/ files. For example:
```bash
docker run -e POSTFIXADMIN_DB_USER_FILE=/run/secrets/postfix-db-user
-e POSTFIXADMIN_DB_PASSWORD_FILE=/run/secrets/postfix-db-passwd
-e POSTFIXADMIN_SETUP_PASSWORD_FILE=/run/secrets/postfix-setup-passwd
postfixadmin
```
All environment vars are supporting the secret's docker strategy.
### Example docker run
```bash
docker run -e POSTFIXADMIN_DB_TYPE=mysqli \
-e POSTFIXADMIN_DB_HOST=whatever \
-e POSTFIXADMIN_DB_USER=user \
-e POSTFIXADMIN_DB_PASSWORD=changeme \
-e POSTFIXADMIN_DB_NAME=postfixadmin \
-e POSTFIXADMIN_SMTP_SERVER=postfix \
-e POSTFIXADMIN_SMTP_PORT=25 \
-e POSTFIXADMIN_ENCRYPT=md5crypt \
-e POSTFIXADMIN_DKIM=YES \
-e POSTFIXADMIN_DKIM_ALL_ADMINS=NO \
--name postfixadmin \
-p 8080:80 \
postfixadmin
```
## Existing setup / with config.local.php
Postfixadmin's default configuration is stored in a config.inc.php file (see https://github.com/postfixadmin/postfixadmin/blob/master/config.inc.php ).
To customise, copy this file, remove everything you don't want to override, and call it **config.local.php**.
```bash
docker run -v /local/path/to/config.local.php:/var/www/html/config.local.php \
--name postfixadmin \
-p 8080:80 \
postfixadmin
```
# Next Steps
Once the container is running, try visiting :
* http://localhost:8080/setup.php (to create admin users)
* http://localhost:8080/ (to login as the domain admin you created through setup.php)
# Docker Compose
Try something like the below in a **docker-compose.yml** file; changing the usernames/passwords as required.
Then run : `docker-compose up`
```yaml
version: '3'
services:
db:
image: mysql:5.7
restart: always
environment:
MYSQL_ROOT_PASSWORD: notSecureChangeMe
MYSQL_DATABASE: postfixadmin
MYSQL_USER: postfixadmin
MYSQL_PASSWORD: postfixadminPassword
postfixadmin:
depends_on:
- db
image: postfixadmin:latest
ports:
- "8000:80"
restart: always
environment:
POSTFIXADMIN_DB_TYPE: mysqli
POSTFIXADMIN_DB_HOST: db
POSTFIXADMIN_DB_USER: postfixadmin
POSTFIXADMIN_DB_NAME: postfixadmin
POSTFIXADMIN_DB_PASSWORD: postfixadminPassword
POSTFIXADMIN_SMTP_SERVER: postfix
POSTFIXADMIN_SMTP_PORT: 25
POSTFIXADMIN_ENCRYPT: md5crypt
```