mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-17 23:52:24 +00:00
docs(truenas): cover the Community train app, its backups, and when the catalog needs a pull request
The TrueNAS page now walks through the catalog install field by field, how to generate the two secrets, where TrueNAS keeps the key and why that is not a backup, a dump and restore from the postgres container shell, and updates with forward-only migrations. The listing is marked as pending review, and the install-via-YAML values stay for the time until it is live. The deploy notes list what needs a matching truenas/apps pull request in the same release cycle: a new or stricter required variable, a port or health check change, a Postgres major or extension, and any other compose-shape change.
This commit is contained in:
1 parent
c1c2ba766c
commit
8d9386d73a
4 files changed
+199
-72
No files matched your search
+20
-5
@@ -199,11 +199,26 @@ dev --create-only --name vX_Y_Z_rollback_<col>`), edit the SQL,
|
||||
|
||||
## Catalog templates
|
||||
|
||||
A new required environment variable, or a change to the compose shape, needs a
|
||||
matching pull request to the TrueNAS apps catalog in the same release cycle
|
||||
(and an update to `docs/self-hosting/unraid/healthlog.xml` and
|
||||
`docs/self-hosting/portainer/templates.json`). See
|
||||
`docs/self-hosting/truenas.md` for what the catalog template carries.
|
||||
The TrueNAS catalog bot follows new image tags on its own, so a routine
|
||||
release needs nothing there. These changes do need a matching pull request to
|
||||
`truenas/apps` (`ix-dev/community/healthlog/`) in the same release cycle, and
|
||||
an update to `docs/self-hosting/unraid/healthlog.xml` and
|
||||
`docs/self-hosting/portainer/templates.json`:
|
||||
|
||||
- a new required environment variable, or a new format or minimum for an
|
||||
existing one (the form validates the secrets);
|
||||
- a changed listening port, health check path or health semantics, or start
|
||||
time beyond the template's five-minute start period;
|
||||
- a required PostgreSQL major version, or an extension the stock `postgres`
|
||||
image does not ship;
|
||||
- any other change to the compose shape: a new container, a volume the app
|
||||
must write to, a different user.
|
||||
|
||||
The catalog app sets `HEALTHLOG_PLATFORM=truenas`, `PORT`, `HOSTNAME`,
|
||||
`DATABASE_URL`, `ENCRYPTION_KEY`, `API_TOKEN_HMAC_KEY`, `APP_URL`,
|
||||
`NEXT_PUBLIC_APP_URL` and `SESSION_COOKIE_SECURE`; everything else reaches it
|
||||
through the form's additional environment variables. See
|
||||
`docs/self-hosting/truenas.md` for the operator side.
|
||||
|
||||
## Verify the served version
|
||||
|
||||
|
||||
Reference in new issue
Block a user