Using provider to provide secrets in service widget

[DominicMCN]

Description

I want to use provider to provide apikey to widgets but it seems not supported according to #2786

I would love use labels for docker swarm service discovery but adding all these secrets to labels would be concerning.

Alternatively, using environment variables available to homepage for these labels would be good too. That way I can just inject secrets to homepage using docker secret and specify them on the docker labels.

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 securely pass API keys or other sensitive information to your widgets without exposing them in labels, you can use environment variables in your configuration files. Homepage supports the use of environment variables that must start with HOMEPAGE_VAR_ or HOMEPAGE_FILE_. The value of an environment variable HOMEPAGE_VAR_XXX will replace {{HOMEPAGE_VAR_XXX}} in any config file, and the value of HOMEPAGE_FILE_XXX must be a file path, with the contents of the file being used to replace {{HOMEPAGE_FILE_XXX}} in any config.

Here's how you can use environment variables with Homepage:

1. Define your environment variables in a .env file or pass them directly to the container using the -e flag with docker run or the environment section in your docker-compose.yml.

2. In your configuration files (such as widgets.yaml or docker.yaml), use the placeholder {{HOMEPAGE_VAR_XXX}} where XXX is the name of your environment variable without the HOMEPAGE_VAR_ prefix.

3. When Homepage starts, it will replace the placeholders with the actual values of the environment variables.

For example, if you have an API key for a weather service, you would set an environment variable like HOMEPAGE_VAR_WEATHER_API=yourapikeyhere, and in your config file, you would use apiKey: {{HOMEPAGE_VAR_WEATHER_API}}.

Remember that for Docker Swarm, you should deploy Homepage on a manager node to ensure that service discovery works correctly. Also, make sure to use service labels instead of container labels for the automatic service discovery to detect all services.

If you encounter any issues or API errors, you can troubleshoot by checking the container logs, browser error console, or by using the Homepage AI Bot for assistance.

Please let me know if you need further clarification on any of these steps.

This comment was generated by Glime.

[DominicMCN]

Can {{HOMEPAGE_VAR_}} be used on docker compose labels?

[github-actions[bot]]

This discussion has been automatically closed because it was marked as answered. See our contributing guidelines for more details.

[github-actions[bot]]

This discussion has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion for related concerns. See our contributing guidelines for more details.