Improved explanation of why this script is needed

Signed-off-by: Thomas L. Kjeldsen <tlk@closureconsulting.com>
This commit is contained in:
Thomas L. Kjeldsen 2020-05-30 02:45:03 +02:00
parent 005da06b3d
commit 903808a477

View file

@ -1,16 +1,21 @@
#!/bin/bash
# Pi-hole: A black hole for Internet advertisements
# (c) 2019 Pi-hole, LLC (https://pi-hole.net)
# (c) 2020 Pi-hole, LLC (https://pi-hole.net)
# Network-wide ad blocking via your own hardware.
#
# Wrapper script to re-enable Pi-hole after a period of it being disabled.
#
# This script will be aborted by the `pihole enable` command using `killall`.
# As a consequence, the filename of this script is limited to max 15 characters
# and the script does not use `env`.
#
# This file is copyright under the latest version of the EUPL.
# Please see LICENSE file for your rights under this license.
#
#
# The pihole disable command has the option to set a specified time before
# blocking is automatically re-enabled.
#
# Present script is responsible for the sleep & re-enable part of the job and
# is automatically terminated if it is still running when pihole is enabled by
# other means.
#
# This ensures that pihole ends up in the correct state after a sequence of
# commands suchs as: `pihole disable 30s; pihole enable; pihole disable`
readonly PI_HOLE_BIN_DIR="/usr/local/bin"