Updates Docker Secrets usage information #1851
Conversation
There was a problem hiding this comment.
Thanks for your PR.
I would not put so much info in this readme as it's already quite long and most users probably won't use the secret file.
Instead, I'd link to link to the documentation at
https://docs.pi-hole.net/docker/configuration/#ftlconf_webserver_api_password-examples
and add the necessary info (e.g. UID/GID) there.
|
Glad to make the changes. I was thinking that the permissions issue was not immediately obvious to me so a note might help clarify this for others. Perhaps I should close this PR as unneeded and generate replacements? |
It is, but I think the readme is not the best place for it.
You could modify the PR to link to the documentation and open a PR at https://github.com/pi-hole/docs |
Docker secrets has a couple of characteristics that may cause baffling errors where configuration looks correct but the pihole container cannot read the secret. The UID and GID of the secret file on the host must be set to the same value used by the pihole process in the container (typically 1000). Signed-off-by: Bradley G Smith <[email protected]>
Docker secrets has a couple of characteristics that may cause baffling errors where configuration looks correct but the pihole container cannot read the secret. The UID and GID of the secret file on the host must be set to the same value used by the pihole process in the container (typically 1000).
Description
Amends the WEBPASSWORD_FILE variable description to provide both Swarm and Compose related links. Directs reader to a docker secrets section in Tips and Tricks.
Adds Tips and Tricks content for docker secrets noting the requirement that the UID for the secrets file must be the same as the pihole process in the container. Otherwise the process will not be able to read the file.
Motivation and Context
Adds useful information that will reduce baffling problems reading a Docker secrets file (WEBPASSWORD_FILE).
How Has This Been Tested?
Tested on my two pihole instances (synology docker host).
Types of changes
Checklist: