webkutir/postfixadmin repository overview

⁠Quick Reference

• Where to get help Our Wiki Page⁠

⁠What is Postfix Admin

Postfix Admin is a web based interface to configure and manage a Postfix based email server for many users. Features include support for virtual domains and aliases, quotas, and vacation/out-of-the-office messages. It requires PHP, Postfix and one of MySQL or PostgreSQL.

⁠Prerequisites

The following components must be available at runtime:

• MySQL >8.0⁠, MariaDB >10.4⁠ or PostgreSQL >14.18⁠ - used as database backend for domains and mailboxes.

⁠How to use this image?

docker run -e PFA_DB_USER=user \
       -e PFA_DB_PASSWORD=topsecret \
       -e PFA_DB_NAME=postfixadmin \
       -e PFA_SETUP_PASS=your_setup_password \
       -e PFA_HOSTNAME=your_server_hostname \
       -e PFA_DOMAIN=your_domain \
       -e VIRTUAL_PORT=3000 \
       --name your-postfixadmin-name \
    webkutir/postfixadmin

...via docker_compose⁠

Example compose.yaml for webkutir/postfixadmin:

services:
  db:
    image: mysql:8.0
    restart: always
    environment:
      MYSQL_RANDOM_ROOT_PASSWORD: 1
      MYSQL_DATABASE: postfixadmin
      MYSQL_USER: postfixadmin
      MYSQL_PASSWORD: example

  postfixadmin:
    depends_on:
      - db
    image: webkutir/postfixadmin
    ports:
      - 3000:3000
    restart: always
    environment:
      PFA_DB_USER: user
      PFA_DB_PASSWORD: topsecret
      PFA_DB_NAME: postfixadmin
      PFA_SETUP_PASS: your_setup_password
      PFA_HOSTNAME: your_server_hostname
      PFA_DOMAIN: your_domain
      VIRTUAL_PORT: 3000

Run docker compose up -d --build, wait for it to initialize completely, and visit http://localhost:3000 or http://host-ip:3000 (as appropriate).

⁠Environment Variables

This image requires various environment variables to be set. The container startup will fail when the setup is incomplete.

⁠Ports

webkutir/postfixadmin exposes port 80 and 443 (the WebUI). No TLS support is built in. So you shall put your container behind an Ingress or Reverse Proxy that enforces HTTPS.

⁠Bootstrap and Setup

Once you have started your PostfixAdmin container successfully, it is now time to perform the first-time setup for your mailserver. Open the web interface and navigate to /index.php.

1. Enter the setup password as you provided it with environment variable PFA_SETUP_PASS.
2. Create your PostfixAdmin administrator account. This is the main account to PostfixAdmin. It will enable you to create domains, mailboxes, aliases, etc.
3. Login to PostfixAdmin by navigating to /login.php.
4. Create your primary domain.
5. Create your first mailbox in this domain.

⁠Additional PostfixAdmin customization

You can further customize the configuration by placing a config.site.php into the /var/www/html folder by using a volume mapping.

⁠Issues

This Docker image is mature and supports my own mailserver in production. There are no known issues at the moment.