tylerhats/polypress repository overview

⁠PolyPress

PolyPress is a self-hosted, multi-tenant email newsletter platform and internal MTA. It features a visual block designer, automated lists subscription preference center, and delivery queue tracking.

This repository hosts the official Docker image for PolyPress.

⁠Quickstart (Docker Compose)

The easiest way to run PolyPress is using Docker Compose. Create a docker-compose.yml file with the following configuration:

version: '3.8'

services:
  polypress:
    image: tylerhats/polypress:latest
    container_name: polypress
    ports:
      - "8000:8000"
    volumes:
      # Mount persistent folders on the host machine to keep your data safe:
      - ./data:/app/data
      - ./backups:/app/backups
      - ./certs:/app/certs
      - ./branding:/app/branding
    environment:
      - INVOCATION_ID=docker
      - DATABASE_URL=sqlite:////app/data/polypress.db
    restart: unless-stopped

⁠Running the Container

Once you have created the docker-compose.yml file, run the following command to start PolyPress in detached mode:

docker compose up -d

PolyPress will be accessible on your host machine at http://localhost:8000.

⁠Configuration & Volumes

To ensure your database and assets are not lost when updating or restarting the container, always mount the persistent volume directories:

• /app/data: Houses the SQLite database file (polypress.db) and history logs (polypress_history.db).
• /app/backups: Stores system backup .zip files generated by the out-of-band backup scheduler.
• /app/branding: Stores your customized application name and logo file (logo.png).
• /app/certs: Houses SSL certificates for HTTPS routing.

⁠Documentation & Wiki

For complete instructions on configuring custom outbound SMTP servers, setting up DKIM records, setting up bounces/complaints loops, and integrating the Developer REST API, please refer to the official documentation:

• PolyPress GitHub Wiki Documentation⁠