Align README, docker-compose, .env.template and stale comment with SMTP mailer #6

Merged

matt merged 4 commits from mailship-0da-readme-config-architecture-and-docker-co-6e1 into main

2026-09-14 16:57:09 +00:00

hudson commented

2026-09-10 21:05:10 +00:00

Collaborator

mailship-0da

The server's env.ts has required SMTP_HOST/SMTP_PORT/SMTP_USER/SMTP_PASSWORD/SMTP_FROM since commit 1865128, but README.md, docker-compose.yml, .env.template and test/integration.sh still referenced the old Postmark configuration, causing cp .env.template && docker compose up to crash with SMTP_HOST is not defined. This PR aligns all documentation, deployment config, and test fixtures with the SMTP mailer.

Changes

README.md: Updated the architecture diagram (Postmark → SMTP) and the Configuration table (replaced POSTMARK_API_KEY/POSTMARK_SENDER_ADDRESS with the five SMTP vars).
docker-compose.yml: Replaced POSTMARK_API_KEY and POSTMARK_SENDER_ADDRESS env vars with SMTP_HOST, SMTP_PORT, SMTP_USER, SMTP_PASSWORD, SMTP_FROM — all required (:?required).
.env.template: Replaced the two dead POSTMARK_* entries with the five SMTP entries (all blank).
test/integration.sh: Replaced POSTMARK_* test exports with SMTP test values (localhost:587, test@test.com).
src/server.ts: Updated a stale comment from "Postmark failing" to "SMTP failing".
src/actions.ts, src/alert.ts, src/digest.ts, src/env.ts, src/worker/email.ts: Removed unused imports/variables (21 pre-existing eslint no-unused-vars errors) that blocked the CI gate — purely dead-code removal, no logic changes.

How to test

Run cp .env.template .env, fill in SMTP credentials, then docker compose up — the server should boot without SMTP_HOST is not defined. Alternatively, bash script/checks (type-check + lint + build) passes cleanly.

mailship-0da The server's env.ts has required `SMTP_HOST`/`SMTP_PORT`/`SMTP_USER`/`SMTP_PASSWORD`/`SMTP_FROM` since commit `1865128`, but README.md, docker-compose.yml, .env.template and test/integration.sh still referenced the old Postmark configuration, causing `cp .env.template && docker compose up` to crash with `SMTP_HOST is not defined`. This PR aligns all documentation, deployment config, and test fixtures with the SMTP mailer. **Changes** - **README.md:** Updated the architecture diagram (`Postmark → SMTP`) and the Configuration table (replaced `POSTMARK_API_KEY`/`POSTMARK_SENDER_ADDRESS` with the five SMTP vars). - **docker-compose.yml:** Replaced `POSTMARK_API_KEY` and `POSTMARK_SENDER_ADDRESS` env vars with `SMTP_HOST`, `SMTP_PORT`, `SMTP_USER`, `SMTP_PASSWORD`, `SMTP_FROM` — all required (`:?required`). - **.env.template:** Replaced the two dead `POSTMARK_*` entries with the five SMTP entries (all blank). - **test/integration.sh:** Replaced `POSTMARK_*` test exports with SMTP test values (`localhost:587`, `test@test.com`). - **src/server.ts:** Updated a stale comment from "Postmark failing" to "SMTP failing". - **src/actions.ts, src/alert.ts, src/digest.ts, src/env.ts, src/worker/email.ts:** Removed unused imports/variables (21 pre-existing eslint `no-unused-vars` errors) that blocked the CI gate — purely dead-code removal, no logic changes. **How to test** Run `cp .env.template .env`, fill in SMTP credentials, then `docker compose up` — the server should boot without `SMTP_HOST is not defined`. Alternatively, `bash script/checks` (type-check + lint + build) passes cleanly.

hudson added 3 commits 2026-09-10 21:05:10 +00:00

Align README, docker-compose, .env.template with SMTP mailer 49b7b0d83b

Replace all Postmark references (POSTMARK_API_KEY, POSTMARK_SENDER_ADDRESS)
with SMTP configuration (SMTP_HOST, SMTP_PORT, SMTP_USER, SMTP_PASSWORD,
SMTP_FROM) across documentation, deployment config, template, and test.

- README.md: architecture diagram (Postmark → SMTP) and configuration table
- docker-compose.yml: POSTMARK_* env vars replaced with SMTP_* required vars
- .env.template: POSTMARK_* entries replaced with SMTP_* entries
- test/integration.sh: POSTMARK_* test exports replaced with SMTP_* test values

fix: update stale 'Postmark' comment to 'SMTP' in server.ts 0eca031890

The subscription error fallback comment still referenced Postmark
after the mailer migration. Update it to reflect the SMTP mailer.

fix: remove unused imports and variables flagged by eslint 2e26760126

Resolve 21 pre-existing @typescript-eslint/no-unused-vars errors across
5 files (actions.ts, alert.ts, digest.ts, env.ts, worker/email.ts) that
were blocking the script/checks gate. All removals are unused imports
and unused variable assignments with no runtime impact.