Best way to manage Homarr settings as Configuration as Code

[instantdreams]

I note that Homarr now supports multiple configuration and allows the selection of different configuration files from the dashboard. I am interested in determining the best practice to manage the configuration as code.

For example:

• custom.json is held in a git repository
• Edits and additions follow the Homarr specifications
• git pull to the directory mapped to /app/data/configs
• Refresh http://localhost:7575/custom and see updates

Apart from the obvious (must follow Homarr specifications or the page breaks) any other concerns people could think of?

[manuel-rw]

Hi 👋, sorry for my late answer.

Here are a few concerns you should think about:

• Homarr is not really built for concurrent editing of users. This means...
  • If a user has a config open, a git pull happens and the user makes changes after that without refreshing the page, it will overwrite the changes from git.
  • A change on the file system will not be reflected instantly on the client. A manual refresh with F5 is required
• Storing secrets in plain text is generally a bad idea. For this reason, we generally don't recommend people to store their files anywhere people can access.
  • This behavior has been improved in Manuel rw gridstack #541 and credentials will no longer be leaked to the client. For 0.11 and ongoing releases, you'll only have to worry about protecting the config on the file system
• I assume that you want to automate configs with CI / CD or automated jobs? If not, make sure that the schema is correct and valid. There might be problems when upgrading to newer versions, as you have to completely re-do some of your automatons. 0.11 will be a version with tons of breaking changes - be prepared :D

I hope this answers your question. If you still have any questions or concerns, let me know! 💪