Skip to content

Comments

Feat: Support yaml config & Update Docs#402

Merged
JW-CH merged 7 commits intomainfrom
dev/jw/yamlConfig
Jul 3, 2025
Merged

Feat: Support yaml config & Update Docs#402
JW-CH merged 7 commits intomainfrom
dev/jw/yamlConfig

Conversation

@JW-CH
Copy link
Collaborator

@JW-CH JW-CH commented Jun 14, 2025

I hate that JSON has no support for comments - YAML does.

TODO: Add example & Update Docs

@JW-CH JW-CH added the enhancement New feature or request label Jun 14, 2025
@JW-CH
Copy link
Collaborator Author

JW-CH commented Jun 14, 2025

@jpg0 I'd be interested in your review if you find some time.

@3rob3
Copy link
Collaborator

3rob3 commented Jun 14, 2025

Somebody just recently asked for this, I can’t find where now. Nice!

Copy link
Contributor

@jpg0 jpg0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only high level thing that I would suggest is whether you want to support the flat structure with YAML, or just go straight to the structured one. If we do remove the flat one at some point, you don't want people having to migrate YAML when they could have gone straight to the V2 version.

Also don't forget docs!

@JW-CH
Copy link
Collaborator Author

JW-CH commented Jun 14, 2025

Only high level thing that I would suggest is whether you want to support the flat structure with YAML, or just go straight to the structured one. If we do remove the flat one at some point, you don't want people having to migrate YAML when they could have gone straight to the V2 version.

Also don't forget docs!

Good point with the v1, does not make sense for people to use that. Docs are on the to-do. Thank you for the review.

@JW-CH JW-CH force-pushed the dev/jw/yamlConfig branch from 8a4853e to 24428a1 Compare June 18, 2025 15:25
@JW-CH JW-CH changed the title Feat: Support yaml config Feat: Support yaml config & Update Docs Jun 18, 2025
@JW-CH JW-CH force-pushed the dev/jw/yamlConfig branch from c9b8729 to df9f326 Compare June 19, 2025 13:15
| -------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ImageRequestedNotification | Notifies when an image is requested. | `{"Name":"ImageRequestedNotification", "ClientIdentifier": "Frame_Kitchen", "DateTime":"2024-11-16T21:37:19.4933981+01:00", "RequestedImageId":"UUID"}` |

### Multiple Immich Accounts
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need more detail on using this, maybe just a "see settings.example.x for more details?

Only override settings you intend to change.
Defaults might change between versions, so keeping your config minimal helps future upgrades.
:::

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have links to settings.example.json and yml here instead of the previous page?

@JW-CH JW-CH merged commit 8fdbff2 into main Jul 3, 2025
5 checks passed
@JW-CH JW-CH deleted the dev/jw/yamlConfig branch October 9, 2025 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants