Adopt OpenCloud config convention and generate config docs - #1
Merged
dragotin merged 5 commits intoAug 25, 2026
Merged
Conversation
Move config from internal/config to pkg/config and split it into config/defaults/parser, matching the OpenCloud service layout. yaml is loaded via github.com/dschmidt/libre-graph-adapter-kit (gookit, avoids the opencloud/pkg/config service-config tree); env vars via opencloud/pkg/config/envdecode. Env vars follow the OC_*/IMMICHFRAME_* convention (was OPENCLOUD_*/FRAME_*). Update main.go, frame, Dockerfile, .env.example, docker-compose (env_file), README and launch.json accordingly.
Generate a service reference site (env-var table, example config) from the tagged config structs via dschmidt/opencloud-service-docs-action, and deploy it to GitHub Pages. `make docs` reproduces the CI build locally.
dschmidt
marked this pull request as draft
August 8, 2026 00:21
Move the OpenCloud connection env vars under IMMICHFRAME_OPENCLOUD_* (space, credentials, insecure) so all backend-connection settings share one prefix, matching music's MUSIC_OPENCLOUD_*. OC_URL/OC_INSECURE stay as shared aliases. Rename the Frame config struct and its yaml section to ImmichFrame (yaml key `immichframe`), since these are the service's own settings.
Load the yaml config file via opencloud/pkg/config.BindSourcesToStructs (env vars still via opencloud/pkg/config/envdecode), so immichframe depends only on regular released opencloud (pinned to the v7.4.0 commit) and not on the adapter kit. This pulls in opencloud's service configs; opencloud-eu/opencloud#3270 extracts BindSourcesToStructs into a leaf package to drop those again.
dschmidt
commented
Aug 8, 2026
| google.golang.org/genproto/googleapis/api v0.0.0-20260526163538-3dc84a4a5aaa // indirect | ||
| google.golang.org/genproto/googleapis/rpc v0.0.0-20260729162451-8efbd57d26e0 // indirect | ||
| google.golang.org/grpc v1.83.0 // indirect | ||
| google.golang.org/protobuf v1.36.11 // indirect |
Contributor
Author
There was a problem hiding this comment.
This list would become muuuuch shorter with opencloud-eu/opencloud#3270 merged
dschmidt
marked this pull request as ready for review
August 8, 2026 00:45
dschmidt
marked this pull request as draft
August 8, 2026 01:02
dschmidt
force-pushed
the
feat/config-opencloud-convention
branch
from
August 8, 2026 01:07
6069c43 to
9275c78
Compare
dschmidt
marked this pull request as ready for review
August 8, 2026 01:09
Move opencloud-service.yml to the repo root, add a docs/intro.md overview overlay, and point the workflow and dev/build-docs.sh at the action's new .cache/service-docs layout (action @8956447).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Aligns config with the OpenCloud convention and generates config docs, like opencloud-music.
Config:
internal/config→pkg/config(config/defaults/parser) withyaml/env/desctags. Env vars groupedIMMICHFRAME_OPENCLOUD_*/IMMICHFRAME_*(breaking: wasOPENCLOUD_*/FRAME_*);OC_URL/OC_INSECUREas shared aliases. yaml + env loading via opencloud's ownpkg/config.BindSourcesToStructs+envdecode, so it depends on regular opencloud (v7.4.0). That currently pulls in opencloud's service configs; opencloud-eu/opencloud#3270 extracts the binder into a leaf package to drop those again.Docs: a GitHub Pages workflow generates the env-var table + example config from the struct tags (one source instead of three).
make docsbuilds it locally; enable Pages → Source: GitHub Actions to publish.