apps/photoprism
1
0
Fork 0
mirror of https://github.com/photoprism/photoprism.git synced 2025-09-26 21:01:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Update AGENTS.md file

Browse Source 
Signed-off-by: Michael Mayer <michael@photoprism.app>
This commit is contained in:
Michael Mayer
2025-09-15 10:44:36 +02:00
parent d3775f02e6
commit b5c9e9f160
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
AGENTS.md
View File

@@ -147,6 +147,7 @@ The following conventions summarize the insights gained when adding new configur
- Add a field to `internal/config/options.go` with `yaml:"…"` and a `flag:"…"` tag.
- Register a CLI flag and env mapping in `internal/config/flags.go` (use `EnvVars(...)`).
- Expose a getter on `*config.Config` in the relevant file (e.g., cluster options in `config_cluster.go`).
- Add name/value to `rows` in `*config.Report()`, after the same option as in `internal/config/options.go` for `photoprism show config` to report it (obfuscate passwords with `*`).
- If the value must persist (e.g., a generated UUID), write it back to `options.yml` using a focused helper that merges keys.
- Tests: cover CLI/env/file precedence and persistence. When tests need a new flag, add it to `CliTestContext` in `internal/config/test.go`.
- Example: `PortalUUID` precedence = `options.yml` → CLI/env (`--portal-uuid` / `PHOTOPRISM_PORTAL_UUID`) → generate UUIDv4 and persist.