.env.example is missing 5 environment variables that config.php reads and README documents #63

Open
opened 2026-08-31 23:57:36 -04:00 by jared · 0 comments
Owner

Severity: Medium (docs / deployment gap)

.env.example is missing MATRIX_DOMAIN, SYNAPSE_ADMIN_URL, SYNAPSE_ADMIN_TOKEN, MATRIX_NOTIFY_COMMENTS, and MATRIX_NOTIFY_ASSIGNMENTS — all five are read in config/config.php (~lines 86-94) and documented in README.md's "Matrix notification variables" section, but none appear in the example file, which explicitly instructs deployers to "Copy this file to .env and fill in your values."

Impact: A deployer following only .env.example has no indication these vars exist, silently missing watcher Matrix DMs (needs SYNAPSE_ADMIN_URL/SYNAPSE_ADMIN_TOKEN to resolve usernames → Matrix IDs) and comment/assignment notifications (the two MATRIX_NOTIFY_* flags) entirely — with no error, since these are all optional/silently-skipped when unset.

Fix: Add all five vars to .env.example with comments matching the README's documentation, so a fresh deployment doesn't silently lose these features.

**Severity:** Medium (docs / deployment gap) `.env.example` is missing `MATRIX_DOMAIN`, `SYNAPSE_ADMIN_URL`, `SYNAPSE_ADMIN_TOKEN`, `MATRIX_NOTIFY_COMMENTS`, and `MATRIX_NOTIFY_ASSIGNMENTS` — all five are read in `config/config.php` (~lines 86-94) and documented in README.md's "Matrix notification variables" section, but none appear in the example file, which explicitly instructs deployers to "Copy this file to .env and fill in your values." **Impact:** A deployer following only `.env.example` has no indication these vars exist, silently missing watcher Matrix DMs (needs `SYNAPSE_ADMIN_URL`/`SYNAPSE_ADMIN_TOKEN` to resolve usernames → Matrix IDs) and comment/assignment notifications (the two `MATRIX_NOTIFY_*` flags) entirely — with no error, since these are all optional/silently-skipped when unset. **Fix:** Add all five vars to `.env.example` with comments matching the README's documentation, so a fresh deployment doesn't silently lose these features.
jared added the documentationpriority/medium labels 2026-09-08 10:15:46 -04:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: LotusGuild/tinker_tickets#63