[Feature Request] notify of missing HOMEPAGE_VARs

[inbredtom]

Description

Just trying to save time for the next user.
When services.yaml file contains references to a var, eg {{HOMEPAGE_VAR_MY_SERVICE}}, but this env var is not defined in the docker compose yaml (usually via .env), the logged error is “error: undefined”. This isn't very illuminating. Perhaps, something like "HOMEPAGE_VAR_MY_SERVICE is used bu not defined."

Other

No response

[glime-ai[bot]]

Thanks for posting a discussion about homepage here on GitHub. Homepage now uses a fancy new AI tool thanks to our friends at Glime, so the answer below is the AI bot's attempt to answer your question. If you feel it's sufficient you can mark the answer and close this post, otherwise feel free to leave it open of course!

Thanks for using Homepage! ❤️

---

To address your suggestion, it would indeed be helpful for users to receive a more descriptive error message when an environment variable referenced in the services.yaml file is not defined in the Docker Compose file or the .env file. A message like "HOMEPAGE_VAR_MY_SERVICE is used but not defined" would provide clearer guidance on what the issue is and how to resolve it.

For the developers or maintainers of the Homepage project, this feedback could be valuable for improving the user experience. You may want to submit this as a feature request or feedback on the project's GitHub repository, either as an issue or a discussion, so that the developers can consider implementing more descriptive error messages for undefined environment variables.

In the meantime, users should ensure that all environment variables referenced in the services.yaml file are properly defined in their Docker Compose or .env files, following the naming convention required by Homepage (i.e., starting with HOMEPAGE_VAR_ for direct value replacement or HOMEPAGE_FILE_ if the value is to be read from a file).

If you encounter this error, double-check your environment variable definitions and make sure they are correctly set up in your Docker environment. You can also refer to the documentation for using environment secrets for further guidance.

This comment was generated by Glime.