Circa July 9, 2022 docker-pi-hole PR 1106 made some significant changes to how the admin password is handled. The only documentation for this change was in
Changelog 2022.07:
Always use WEBPASSWORD env var if set by @rdwebdesign in #1106
If WEBPASSWORD is not set on first launch, a random password is generated.
If WEBPASSWORD is not set on second-or-subsequent launch, whatever password was already in effect is re-used. This also applies when there is no admin password.
If WEBPASSWORD is defined but has a null value, any pre-existing password is cleared and the Web UI bypasses the login screen.
If WEBPASSWORD is defined and has a value, that value is always used to update the admin password stored internally.
This PR adjusts the IOTstack Pi-hole template to default to the third option above (ie no admin password). This avoids the need for any "build" process and the need to set/generate any password, and obviates the need for the associated Python scripts which have been removed.
A comment is added to the service definition template directing users to the IOTstack wiki page where the behaviour of WEBPASSWORD is documented in full.
This change should only affect new users.
Any existing users who had followed the previous procedure of selecting Pi-hole, choosing a password or allowing one to be generated, and bringing up the container would have an admin password matching the value of WEBPASSWORD.
Any existing users who had reset their password via:
$ docker exec pihole pihole -a -p myNewPassword
will either have:
Changed their service definition to match. The July 9 2022 changes would already be enforcing WEBPASSWORD on each launch.
Not changed their service definition to match. The July 9 2022 changes would already have reverted to the value of WEBPASSWORD.
Removed WEBPASSWORD from their list of environment variables. The July 9 2022 changes would continue to use the existing password.
This PR also takes the opportunity to:
Re-align the service definition entries.
Adopt new-style TZ which either accepts a value from ~/IOTstack/.env or defaults to Etc/UTC.
Add a comment pointing to the Pi-hole documentation for its supported environment variables.
Circa July 9, 2022 docker-pi-hole PR 1106 made some significant changes to how the admin password is handled. The only documentation for this change was in Changelog 2022.07:
This change was reported on Discord.
To summarise the new behaviour:
WEBPASSWORDis not set on first launch, a random password is generated.WEBPASSWORDis not set on second-or-subsequent launch, whatever password was already in effect is re-used. This also applies when there is no admin password.WEBPASSWORDis defined but has a null value, any pre-existing password is cleared and the Web UI bypasses the login screen.WEBPASSWORDis defined and has a value, that value is always used to update the admin password stored internally.This PR adjusts the IOTstack Pi-hole template to default to the third option above (ie no admin password). This avoids the need for any "build" process and the need to set/generate any password, and obviates the need for the associated Python scripts which have been removed.
A comment is added to the service definition template directing users to the IOTstack wiki page where the behaviour of
WEBPASSWORDis documented in full.This change should only affect new users.
Any existing users who had followed the previous procedure of selecting Pi-hole, choosing a password or allowing one to be generated, and bringing up the container would have an admin password matching the value of
WEBPASSWORD.Any existing users who had reset their password via:
will either have:
WEBPASSWORDon each launch.WEBPASSWORD.WEBPASSWORDfrom their list of environment variables. The July 9 2022 changes would continue to use the existing password.This PR also takes the opportunity to:
~/IOTstack/.envor defaults toEtc/UTC.IOTstack Pi-hole documentation updated.
Signed-off-by: Phill Kelley 34226495+Paraphraser@users.noreply.github.com