docs: EventSaver has no compiled-in folder fallback any more
Some checks failed
CI / naming (push) Successful in 3s
CI / frontend (push) Successful in 12s
CI / migrations-mysql (push) Successful in 41s
CI / backend (push) Failing after 5m3s

The adoption guide told an adopting site that a missing EventSaver.ini makes
the binary fall back to "the reference site's file server". That was true of
EventSaver.cs until the ADR-015 fix set Folder to empty, and EVENTSAVER.md was
updated then while this page was not, so the two documents disagreed about what
a missing ini does.

Current behaviour is that it shows nothing, which is the point: failing visibly
beats displaying another site's slides. Says that, and adds the case the old
text was accidentally describing - a .scr compiled before the fix still carries
the path, so a binary somebody was handed is not the same as one they built.

Scope: product
This commit is contained in:
cproudlock
2026-09-04 08:28:39 -04:00
parent bfc30f4c7c
commit 349e8c89bd

View File

@@ -275,10 +275,17 @@ showing the last set instead of going black.
### The two things that catch people out
**The compiled-in fallback is not yours.** If `EventSaver.ini` is missing or
both `url` and `folder` are blank, the binary falls back to a folder path
compiled into `EventSaver.cs`, which is the reference site's file server. Ship
the ini. A missing ini is not a neutral default.
**There is no compiled-in fallback - ship the ini.** If `EventSaver.ini` is
missing, or both `url` and `folder` are blank, EventSaver has no source to read
and shows nothing. That is deliberate: the source used to carry the reference
site's file server as its default `Folder`, so a missing ini silently pointed a
new site at someone else's share. It is empty now (ADR-015), and failing
visibly beats displaying another site's slides.
Check any binary you were handed rather than built. A `.scr` compiled before
2026-08-18 still has that path baked in, and it will use it the moment the ini
goes missing. Build from the source in `plugins/slides/client/` - see BUILD
instructions in [EVENTSAVER.md](EVENTSAVER.md).
**If you enforce the ini by hash, your own edits revert.** The reference
manifest pins `EventSaver.ini` with `DetectionMethod: Hash`, which is what makes