mifi-holdings/mail-postfixadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Prettier
Some checks failed
ci/woodpecker/push/ci Pipeline failed
Details
ci/woodpecker/push/build unknown status
Details
ci/woodpecker/push/deploy unknown status
Details

Browse Source
This commit is contained in:
Mike Fitzpatrick
2026-02-12 19:43:46 -03:00
parent 56604ada0a
commit edba9636f0
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -11,19 +11,19 @@ Custom PostfixAdmin Docker image and stack for managing Postfix mail server (dom
## Repository layout ## Repository layout
| Path | Purpose | | Path | Purpose |
|------|--------| | ------------------------ | ------------------------------------------------------------------------------ |
| `conf/config.local.php` | ENV-driven PostfixAdmin config (baked into image). | | `conf/config.local.php` | ENV-driven PostfixAdmin config (baked into image). |
| `Dockerfile` | Builds from `postfixadmin`, copies `conf/config.local.php`. | | `Dockerfile` | Builds from `postfixadmin`, copies `conf/config.local.php`. |
| `docker-compose.yml` | Sample stack: one service, env vars enumerated so the container receives them. | | `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). | | `.env.example` | Documents all `PFA_*` variables (required vs optional, no secrets). |
| `.woodpecker/ci.yml` | CI: install deps, Prettier format check, YAML lint. | | `.woodpecker/ci.yml` | CI: install deps, Prettier format check, YAML lint. |
| `.woodpecker/build.yml` | Build: Docker build (linux/amd64), push to registry. | | `.woodpecker/build.yml` | Build: Docker build (linux/amd64), push to registry. |
| `.woodpecker/deploy.yml` | Deploy: trigger stack redeploy via webhook (no clone). | | `.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). 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. - **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.). - **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.).