rajaseg/anonaddy repository overview

⁠About

AnonAddy⁠ Docker image based on Alpine Linux.
If you are interested, check out⁠ my other Docker images!

💡 Want to be notified of new releases? Check out 🔔 Diun (Docker Image Update Notifier)⁠ project!

• Features⁠
• Build locally⁠
• Image⁠
• Environment variables⁠
  • General⁠
  • App⁠
  • AnonAddy⁠
  • Database⁠
  • Redis⁠
  • Mail⁠
  • Postfix⁠
  • DKIM⁠
  • DMARC⁠
• Volumes⁠
• Ports⁠
• Usage⁠
  • Docker Compose⁠
• Upgrade⁠
• Notes⁠
  • anonaddy command⁠
  • Create user⁠
  • Generate DKIM private/public keypair⁠
• How can I help?⁠
• License⁠

⁠Features

• Run as non-root user
• Multi-platform image
• s6-overlay⁠ as process supervisor
• Traefik⁠ as reverse proxy and creation/renewal of Let's Encrypt certificates (see this template⁠)

⁠Build locally

git clone https://github.com/anonaddy/docker.git docker-anonaddy
cd docker-anonaddy

# Build image and output to docker (default)
docker buildx bake

# Build multi-platform image
docker buildx bake image-all

⁠Image

Following platforms for this image are available:

$ docker run --rm mplatform/mquery anonaddy/anonaddy:latest
Image: anonaddy/anonaddy:latest
 * Manifest List: Yes
 * Supported platforms:
   - linux/amd64
   - linux/arm/v6
   - linux/arm/v7
   - linux/arm64
   - linux/386
   - linux/ppc64le
   - linux/s390x

⁠Environment variables

⁠General

• TZ: The timezone assigned to the container (default UTC)
• PUID: AnonAddy user id (default 1000)
• PGID: AnonAddy group id (default 1000)
• MEMORY_LIMIT: PHP memory limit (default 256M)
• UPLOAD_MAX_SIZE: Upload max size (default 16M)
• CLEAR_ENV: Clear environment in FPM workers (default yes)
• OPCACHE_MEM_SIZE: PHP OpCache memory consumption (default 128)
• LISTEN_IPV6: Enable IPv6 for Nginx (default true)
• REAL_IP_FROM: Trusted addresses that are known to send correct replacement addresses (default 0.0.0.0/32)
• REAL_IP_HEADER: Request header field whose value will be used to replace the client address (default X-Forwarded-For)
• LOG_IP_VAR: Use another variable to retrieve the remote IP address for access log_format⁠ on Nginx. (default remote_addr)

⁠App

• APP_NAME: Name of the application (default AnonAddy)
• APP_KEY: Application key for encrypter service. You can generate one through anonaddy key:generate --show or echo "base64:$(openssl rand -base64 32)". required
• APP_DEBUG: Enables or disables debug mode, used to troubleshoot issues (default false)
• APP_URL: The URL of your AnonAddy installation

⁠AnonAddy

• ANONADDY_RETURN_PATH: Return-path header for outbound emails
• ANONADDY_ADMIN_USERNAME: If set this value will be used and allow you to receive forwarded emails at the root domain
• ANONADDY_ENABLE_REGISTRATION: If set to false this will prevent new users from registering on the site (default true)
• ANONADDY_DOMAIN: Root domain to receive email from required
• ANONADDY_HOSTNAME: FQDN hostname for your server used to validate records on custom domains that are added by users
• ANONADDY_DNS_RESOLVER: Custom domains that are added by users to validate records (default 127.0.0.1)
• ANONADDY_ALL_DOMAINS: Other domains to use
• ANONADDY_SECRET: Long random string used when hashing data for the anonymous replies required
• ANONADDY_LIMIT: Number of emails a user can forward and reply per hour (default 200)
• ANONADDY_BANDWIDTH_LIMIT: Monthly bandwidth limit for users in bytes domains to use (default 104857600)
• ANONADDY_NEW_ALIAS_LIMIT: Number of new aliases a user can create each hour (default 10)
• ANONADDY_ADDITIONAL_USERNAME_LIMIT: Number of additional usernames a user can add to their account (default 3)
• ANONADDY_SIGNING_KEY_FINGERPRINT: GPG key used to sign forwarded emails. Should be the same as your mail from email address

⁠Database

• DB_HOST: MySQL database hostname / IP address required
• DB_PORT: MySQL database port (default 3306)
• DB_DATABASE: MySQL database name (default anonaddy)
• DB_USERNAME: MySQL user (default anonaddy)
• DB_PASSWORD: MySQL password
• DB_TIMEOUT: Time in seconds after which we stop trying to reach the MySQL server (useful for clusters, default 60)

⁠Redis

• REDIS_HOST: Redis hostname / IP address
• REDIS_PORT: Redis port (default 6379)
• REDIS_PASSWORD: Redis password

⁠Mail

• MAIL_FROM_NAME: From name (default AnonAddy)
• MAIL_FROM_ADDRESS: From email address (default anonaddy@${ANONADDY_DOMAIN})

⁠Postfix

• POSTFIX_DEBUG: Enable debug (default false)
• POSTFIX_SMTPD_TLS: Enabling TLS in the Postfix SMTP server (default false)
• POSTFIX_SMTPD_TLS_CERT_FILE: File with the Postfix SMTP server RSA certificate in PEM format
• POSTFIX_SMTPD_TLS_KEY_FILE: File with the Postfix SMTP server RSA private key in PEM format
• POSTFIX_SMTP_TLS: Enabling TLS in the Postfix SMTP client (default false)

⁠DKIM

• DKIM_ENABLE: Enable OpenDKIM service. (default false)
• DKIM_REPORT_ADDRESS: Specifies the string to use in the From: header field for outgoing reports (default postmaster@${ANONADDY_DOMAIN})

⁠DMARC

• DMARC_ENABLE: Enable OpenDMARC service. (default false)
• DMARC_FAILURE_REPORTS: Enables generation of failure reports when the DMARC test fails (default false)
• DMARC_MILTER_DEBUG: Sets the debug level to be requested from the milter library (default 0)

⁠Volumes

• /data: Contains storage

⁠Ports

• 8000: HTTP port
• 25: SMTP port (postfix)

⁠Usage

⁠Docker Compose

Docker compose is the recommended way to run this image. You can use the following docker compose template⁠, then run the container:

docker-compose up -d
docker-compose logs -f

⁠Upgrade

You can upgrade AnonAddy automatically through the UI, it works well. But I recommend to recreate the container whenever I push an update:

docker-compose pull
docker-compose up -d

⁠Notes

⁠anonaddy command

If you want to use the artisan command to perform common server operations like manage users, passwords and more, type:

docker-compose exec anonaddy anonaddy <command>

For example to list all available commands:

docker-compose exec anonaddy anonaddy list

⁠Create user

docker-compose exec anonaddy anonaddy anonaddy:create-user "username" "[email protected]"

⁠Generate DKIM private/public keypair

docker-compose run --entrypoint '' anonaddy gen-dkim

opendkim-genkey: generating private key
opendkim-genkey: private key written to example.com.private
opendkim-genkey: extracting public key
opendkim-genkey: DNS TXT record written to example.com.txt

The keypair will be available in /data/dkim.

⁠How can I help?

All kinds of contributions are welcome :raised_hands:! The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon: You can also support this project by becoming a sponsor on GitHub⁠ :clap: or by making a Paypal donation⁠ to ensure this journey continues indefinitely! :rocket:

Thanks again for your support, it is much appreciated! :pray:

⁠License

MIT. See LICENSE for more details.