diff --git a/README.md b/README.md index 50b4381..75d81d8 100644 --- a/README.md +++ b/README.md @@ -11,19 +11,19 @@ Custom PostfixAdmin Docker image and stack for managing Postfix mail server (dom ## Repository layout -| Path | Purpose | -|------|--------| -| `conf/config.local.php` | ENV-driven PostfixAdmin config (baked into image). | -| `Dockerfile` | Builds from `postfixadmin`, copies `conf/config.local.php`. | -| `docker-compose.yml` | Sample stack: one service, env vars enumerated so the container receives them. | -| `.env.example` | Documents all `PFA_*` variables (required vs optional, no secrets). | -| `.woodpecker/ci.yml` | CI: install deps, Prettier format check, YAML lint. | -| `.woodpecker/build.yml` | Build: Docker build (linux/amd64), push to registry. | -| `.woodpecker/deploy.yml` | Deploy: trigger stack redeploy via webhook (no clone). | +| Path | Purpose | +| ------------------------ | ------------------------------------------------------------------------------ | +| `conf/config.local.php` | ENV-driven PostfixAdmin config (baked into image). | +| `Dockerfile` | Builds from `postfixadmin`, copies `conf/config.local.php`. | +| `docker-compose.yml` | Sample stack: one service, env vars enumerated so the container receives them. | +| `.env.example` | Documents all `PFA_*` variables (required vs optional, no secrets). | +| `.woodpecker/ci.yml` | CI: install deps, Prettier format check, YAML lint. | +| `.woodpecker/build.yml` | Build: Docker build (linux/amd64), push to registry. | +| `.woodpecker/deploy.yml` | Deploy: trigger stack redeploy via webhook (no clone). | Secrets and deployment-specific values are not stored in the repo; they are supplied at deploy time (e.g. stack environment in your orchestration UI). -## Configuration (PFA_* env vars) +## Configuration (PFA\_\* env vars) - **Required (no default):** `PFA_SETUP_PASSWORD`, `PFA_DATABASE_PASSWORD`, `PFA_ADMIN_SMTP_PASSWORD`. The app will exit with a clear error if any of these are missing. - **Optional:** All other `PFA_*` variables have defaults in `config.local.php`. Override them via environment to match your site (database host, site URL, branding, SMTP, quotas, feature flags, etc.).