docs/CONFIGURATION.md and docs/API.md describe what the relay actually serves #213

2026-09-22T01:09:25Z

paulhitt commented

2026-09-22 01:09:25 +00:00

(Migrated from gitlab.com)

The file opens by saying it lists every variable the relay reads, and
that a variable absent from it is not read. An operator sets what it
names on a machine holding other people's messages. Twenty-one were
read and undocumented: the six object-storage settings, the Redis URL
and replica count, the per-account device cap and expiry, the monthly
attachment allowance, the capacity ceiling, the SMTP password, the
Android release fields, the two connection-pool sizes, the working
directory, and FN_ROSTER_ON_SERVER, which decides whether the relay
stores the contact graph at all.

Five table rows were also stranded above the page title, with no header
row above them, so flamenetmessenger.com/configuration opened with a
paragraph of raw pipe characters before its own heading. Four of them
were the only mention of FN_REPORTS_TO, FN_CONTACT_EMAIL, the six
per-role contact addresses and FN_REPORT_RETENTION_DAYS; the fifth
duplicated a row further down. They are in the report and site-copy
tables now. A blank line inside the limits table was splitting it in two
on the rendered page.

Scripts/check-configuration-doc.py keeps the claim true, wired into CI
next to the doc-pages gate. It matches whole names, since the first
version compared substrings and a renamed variable still satisfied it.
Falsified three ways: renaming a variable, deleting its row, and
dropping the interpolated FN_CONTACT_ family are each caught.

Co-Authored-By: Claude Opus 5 noreply@anthropic.com

The file opens by saying it lists every variable the relay reads, and that a variable absent from it is not read. An operator sets what it names on a machine holding other people's messages. Twenty-one were read and undocumented: the six object-storage settings, the Redis URL and replica count, the per-account device cap and expiry, the monthly attachment allowance, the capacity ceiling, the SMTP password, the Android release fields, the two connection-pool sizes, the working directory, and FN_ROSTER_ON_SERVER, which decides whether the relay stores the contact graph at all. Five table rows were also stranded above the page title, with no header row above them, so flamenetmessenger.com/configuration opened with a paragraph of raw pipe characters before its own heading. Four of them were the only mention of FN_REPORTS_TO, FN_CONTACT_EMAIL, the six per-role contact addresses and FN_REPORT_RETENTION_DAYS; the fifth duplicated a row further down. They are in the report and site-copy tables now. A blank line inside the limits table was splitting it in two on the rendered page. Scripts/check-configuration-doc.py keeps the claim true, wired into CI next to the doc-pages gate. It matches whole names, since the first version compared substrings and a renamed variable still satisfied it. Falsified three ways: renaming a variable, deleting its row, and dropping the interpolated FN_CONTACT_<role> family are each caught. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

paulhitt commented

2026-09-22 01:09:26 +00:00

(Migrated from gitlab.com)

assigned to @paulhitt

paulhitt commented

2026-09-22 10:47:58 +00:00

(Migrated from gitlab.com)

mentioned in commit 5afc4a0472

mentioned in commit 5afc4a047247463a6bcc74001abca94b01e22bd3

paulhitt (Migrated from gitlab.com) merged commit 5afc4a0472 into main

2026-09-22 10:47:58 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: extant2000/flamenet-relay#213