Commit Graph

267 Commits

Author SHA1 Message Date
Peter Dave Hello e459169d8a Fix typo in README.md "Optional Variables" (IPv6) 2022-02-16 17:13:39 +08:00
edgd1er 140312b79c Redirect lighttpd logs to stdout
Signed-off-by: edgd1er <edgd1er@hotmail.com>
2022-01-27 04:17:42 +01:00
Adam Warner 778e993903
Move variable description to the Experimental section
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2022-01-20 17:12:18 +00:00
edgd1er 0ecde45d22 removed vars in compose sample.
Signed-off-by: edgd1er <edgd1er@hotmail.com>
2022-01-17 15:28:25 +01:00
edgd1er 2cec4fa719 change UID / GID for www-data and pihole user.
When mounting volumes, specific rights may be needed to write on mounted volumes on the host.

Signed-off-by: edgd1er <edgd1er@hotmail.com>
2022-01-17 15:28:25 +01:00
Adam Warner e0f05ef372
Remove any existing PIHOLE_DNS_ configurations before applying those that have been passed in via env var
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2022-01-09 21:05:53 +00:00
Adam Warner 2fb2202a17
Sync the minimal docker-compose examples. Remove note about pihole.log, it isn't neccasery (https://github.com/pi-hole/docker-pi-hole/issues/809)
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2022-01-09 19:04:19 +00:00
Adam Warner 25a8e0dcba
Merge pull request #970 from AlexanderLieret/patch-webtheme
Update list of available web themes
2022-01-07 23:46:07 +00:00
Alexander Lieret 28892f4533
Update list of available web themes
Signed-off-by: Alexander Lieret <alexander.lieret@fau.de>
2022-01-06 17:16:04 +01:00
Adam Warner 2c6bc33e8d
Increase verbosity of error message when capabilities cannot be set - add note to readme about default DNSMASQ_USER. See #963 for details (#964)
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2022-01-04 18:50:37 +00:00
Adam Warner 2a7ea09d00
Readme tweaks
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2022-01-02 15:54:09 +00:00
Phill b0a5a0f163
Trailing slashes on volumes fail on newer versions of docker-compose (#949)
* Trailing slashes on volumes fail on newer versions of docker-compose

See [Issue 947](https://github.com/pi-hole/docker-pi-hole/issues/947)
for the background.

This PR proposes removing trailing slashes from all documentation,
examples and scripts.

Signed-off-by: Phill Kelley <pmk.57t49@lgosys.com>
2021-12-11 13:37:18 +00:00
Adam Warner 7049b5df03
remove references to porrt 443
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2021-12-09 17:09:36 +00:00
AlexandreRatte 4aaf0998a3
Customize pihole-FTL.conf with FTLCONF_ prefixed environment variables. (#944)
* Customize pihole-FTL.conf with FTLCONF_ prefixed environment variables.

Signed-off-by: Alexandre Ratte <alexandre.ratte@gmail.com>

* Reintroduced parsing of ServerIP* env vars and amended README for deprecated variables.

Signed-off-by: Alexandre Ratte <alexandre.ratte@gmail.com>
2021-11-26 16:58:10 +00:00
moritzbeck01 ff776c2ba4
[skip ci] Fixed link to reverse proxy (#939)
The example seems to no longer be using jwilder/nginx-proxy but the very similar nginxproxy/nginx-proxy. Additionally the link to the example was broken.
2021-10-31 14:41:55 +00:00
Adam Warner 0cceed3c83
Merge branch 'master' into dev 2021-09-06 22:43:22 +01:00
DL6ER ec3b4609bc
Add CAP_SYS_NICE, CAP_IPC_LOCK, CAP_CHOWN capabilites recommendation
Signed-off-by: DL6ER <dl6er@dl6er.de>
2021-09-06 22:33:09 +02:00
Maja Bojarska 2fcc4f66ee Fix typos "Descrption" 2021-08-15 14:15:09 +02:00
Adam Warner 91d75416b8
Merge branch 'dev' into fix-dns-bogus-priv 2021-08-04 18:36:18 +01:00
Adam Warner 559b317148
Merge branch 'dev' into master 2021-08-04 18:32:59 +01:00
Adam Warner 92999dff08
Merge pull request #886 from gbrsni/dev
Small correction in the 'Quick Start' section of the README
2021-08-04 18:29:00 +01:00
Adam Warner bf82c2e8f5
[skip ci] Merge new envvar layout from master into dev
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2021-08-04 11:36:55 +01:00
Dan Schaper 8565c3828d
[skip ci] Break out defaults and values for clarity.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2021-08-03 13:43:44 -07:00
Dan Schaper d0e6b77fdb
Break out defaults and values for clarity.
Signed-off-by: Dan Schaper <dan.schaper@pi-hole.net>
2021-08-03 12:06:09 -07:00
gbrsni b5046af667
Update README.md
Now suggesting usage of the '-d' flag.
2021-07-28 07:56:31 +00:00
Adam Warner 7d82719839
Add note to README
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2021-07-21 19:45:28 +01:00
Adam Warner 28b5154e52
Include information about nightly/beta tags
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2021-07-04 22:07:46 +01:00
Adyanth H 3022fa5092 Update README.md to add changes in #867
Signed-off-by: Adyanth H <adyanthh@gmail.com>
2021-07-04 13:09:16 +00:00
Tiago Seabra f95bcba67a docs: add WEBPASSWORD_FILE to README
Signed-off-by: Tiago Seabra <tlgs@users.noreply.github.com>
2021-06-17 16:03:36 +01:00
Orazio 39fa779653
Fix DNS_BOGUS_PRIV description
Setting the DNS_BOGUS_PRIV variable to true blocks (not enables) reverse dns lookups for private ranges.
2021-05-20 15:00:34 +02:00
Alexandre Ratte 2484c9ced2 Merge branch 'dev' of https://github.com/AlexandreRatte/docker-pi-hole into Issue_778
Signed-off-by: Alexandre Ratte <alexandre.ratte@gmail.com>
2021-05-15 08:38:43 -04:00
Alexandre Ratte d0c152eb25 Documented WEBTHEME environment variable.
Signed-off-by: Alexandre Ratte <alexandre.ratte@gmail.com>
2021-05-15 08:31:24 -04:00
jparenas 73378d1231 Add CUSTOM_CACHE_SIZE environment variable to the available options
Signed-off-by: jparenas <juan.p.arenas1@gmail.com>
2021-05-08 16:11:57 -05:00
Matthew Beckler f9c51379b0 Add note regarding changing Pi-hole DNS setting when using docker bridge networking 2021-04-29 14:42:50 -05:00
Adam Warner 2e04f5abee
Add upgrade note for v.58 2021-04-19 09:38:15 +01:00
Adam Warner 59c08f36ee
Revert "Add `hostname` to docker-compose" 2021-04-17 00:53:51 +01:00
Adam Warner dba2317072
Merge pull request #769 from ignic/dhcp_setup
Enable DHCP Server with environment variables
2021-04-16 23:45:43 +01:00
Adam Warner 4b7c35be7e
Merge pull request #743 from e2jk/docker-hostname
Add `hostname` to docker-compose
2021-04-16 23:31:56 +01:00
Adam Warner 4f531d9e78
Irrelevant since IP blocking is no longer the default method.
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2021-04-16 21:55:55 +01:00
Adam Warner 6f865b1699
Remove some out of date info about not remapping port 80.
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2021-04-16 18:40:47 +01:00
Adam Warner ba6f7f9d62
remove Upgrade notices section. It's old, and there isn't really anything relevant in there any more. 2021-04-16 18:33:01 +01:00
Adam Warner c0e55c156f
Remove port 443 from templates and documentation. (Redo) (#808)
* Update docker_run.sh

* Update docker-compose.yml.example

* Update README.md

* Update Dockerfile

Co-authored-by: Dan Schaper <dan.schaper@pi-hole.net>
2021-02-26 20:09:31 +00:00
Adam Warner c5484e6a85
Merge pull request #792 from optimusprime01/devel
fixing typos in ReadMe
2021-02-16 09:15:31 +00:00
Sachin Sunder Sagadevan dad930f9d2 fixing typos in ReadMe
Signed-off-by: Sachin Sunder Sagadevan <sachsun2809@outlook.com>
2021-02-15 20:25:12 -08:00
Adam Warner b39f53d12e
Merge pull request #790 from Sounie/documentation-tidy-ups
Couple of typos in docs.
2021-02-12 20:34:45 +00:00
Stephen Souness a51f69bef9 Couple of typos in docs. 2021-02-12 19:23:55 +00:00
Benjamin Löhden 7adccc0287 Update README.md
Signed-off-by: Benjamin Löhden <3964467+loehden@users.noreply.github.com>
2021-02-09 00:17:28 +01:00
Ignacio Serrano e40ed3b5cc update doc README.md with DHCP server setup
Signed-off-by: Ignacio Serrano <ignic@ignic.com>
2021-01-23 21:23:05 +01:00
Emilien Klein 8f53e1bd22 Using pi.hole as hostname
To be consistent with the parameter already defined in docker_run.sh
(leaving the jwilder-proxy example to pihole.yourDomain.lan to be 
consistent with the rest of that file's content, namely DEFAULT_HOST)
2020-12-27 16:10:45 +01:00
Emilien Klein 64a1f548ef Add `hostname` to docker-compose
If this is not set, the PiHole admin page shows the Docker container's 
ID as hostname instead.
2020-12-27 15:24:29 +01:00
Adam Warner f77e4609ce
Introduce new env VAR for setting PIHOLE_DNS_x values.
If not set, keep existing values in setupVars
if no existing values in setupVars - fall back to defaults

Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2020-12-16 21:41:09 +00:00
Adam Warner 8c62a1437a
Merge pull request #690 from damajor/patch-1
Add QUERY_LOGGING missing export
2020-12-03 18:18:12 +00:00
Adam Warner 121f3f92c9
Merge pull request #714 from mparramont/patch-1
Fix file to copy in  README.md
2020-12-02 21:32:52 +00:00
Miguel Parramon b669826149 Update README.md
😄

Signed-off-by: Miguel Parramón <mparramont@gmail.com>
2020-12-02 15:36:57 +08:00
DL6ER 105eb1165f
Update README.md
Co-authored-by: Adam Warner <me@adamwarner.co.uk>
2020-12-01 19:56:55 +01:00
Adam Warner e7bfad6301
Introduce new REV_SERVER environment variables. Deprecate CONDITIONAL_FORWARDING ones, but maintain backward compatibility
Signed-off-by: Adam Warner <me@adamwarner.co.uk>
2020-11-30 21:46:50 +00:00
-_- e67952eaec
Merge branch 'dev' into patch-1 2020-11-12 22:44:42 +01:00
-_- 9324107088
QUERY_LOGGING Documentation update 2020-10-11 17:28:37 +02:00
Daniel a779c7fc37
Make the default debian version buster, preserve the 'stretch' tag for those who need it.
Signed-off-by: Daniel <daniel@developerdan.com>
2020-09-28 17:12:03 -04:00
Adam Hill 87132465b5
Merge pull request #672 from AthrogatePEQ/master
Ability to skip Gravity refresh on startup
2020-08-22 20:38:17 -05:00
Athrogate 97d00cd936 Update README.md
Documenting the SKIPGRAVITYONBOOT variable.

Signed-off-by: Tyler Spires <shadrach145@gmail.com>
2020-08-22 18:17:17 -04:00
Athrogate 5a35eca5e2 Update README.md
Signed-off-by: Tyler Spires <shadrach145@gmail.com>
2020-08-22 18:17:17 -04:00
Athrogate 6e5bf71595 Update README.md
Signed-off-by: Tyler Spires <shadrach145@gmail.com>
2020-08-22 18:17:17 -04:00
Athrogate a9f423ff37 Update README.md
Signed-off-by: Tyler Spires <shadrach145@gmail.com>
2020-08-22 18:17:17 -04:00
Athrogate a30bd0528f Update README.md
Signed-off-by: Tyler Spires <shadrach145@gmail.com>
2020-08-22 18:17:17 -04:00
Felix Wong 93b86c8981
use docker-compose example yaml
Signed-off-by: Felix Wong <felix@fawong.com>
2020-08-17 20:09:39 +00:00
Daniel 752d83aeaa
Introduce additional docker tags for the debian version.
* Added new docker tag variations to specify the debian version ('stretch', and 'buster').
* Arch images are alway as specific as possible: pihole/pihole:master-amd64-stretch
* Multiarch images have both the specific debian version tags as well as the generic non-debian tags: pihole/pihole:master-stretch & pihole/pihole:master
* Currently, the non-specific tags point to the 'stretch' images. Eventaully it can be migrated to 'buster'.
* Use GitHub actions to do the builds. Although the script names include 'gh-actions' to differentiate them from the 'circle' scripts, there is zero logic that is specific to Github (ie. no Github environment variables).
* 'armhf:buster' & 'arm64:buster' has an issue with `ip route get`. I think the issue is related to 'qemu', but I'm not sure. Update the `validate_env` function to only use `ip route get` if `nc` reports something strange.

Signed-off-by: Daniel <daniel@developerdan.com>
2020-06-29 09:34:19 -04:00
Adam Hill 9213bbd322 Merge branch 'dev' of github.com:diginc/docker-pi-hole into no_resolv_check
Signed-off-by: Adam Hill <adam@diginc.us>
2020-05-30 18:03:05 -05:00
Adam Hill 808359e832
Merge pull request #608 from ahuffman/master
Fixes #557
2020-05-27 00:02:06 -05:00
Adam Hill d7fdb188ed remove resolv conf checks
Signed-off-by: Adam Hill <adam@diginc.us>
2020-05-26 10:45:48 -05:00
Daniel 6939ea024f
Simplify Dockerfile configuration.
* Simplify docker builds by consolidating all arch's into a single Dockerfile and using ARGS for various differences
* Introduce docker-compose based builds (build.yml) for simple management of the various args differences

Signed-off-by: Daniel <daniel@developerdan.com>
2020-05-15 16:06:48 -04:00
Adam Hill 8cb67fde23
Merge pull request #515 from mgalgs/docker-run-storage-dir
docker_run.sh: Add env var to specify storage directory
2020-05-11 19:02:30 -05:00
Adam Hill 032b53799d
Merge pull request #534 from warren-fisher/dev
Add to Ubuntu install section
2020-05-06 21:46:29 -05:00
Andrew J. Huffman 2228115a97
Fixes #557
* Refactored the prepare_configs function in bash_functions.sh
* Now able to set settings via the UI or ENV Variables - ENV Variables override when restarted
* Added ENV Variables for ADMIN_EMAIL, TEMPERATUREUNIT, and WEBUIBOXEDLAYOUT
    - Created setup_temp_unit function in bash_functions.sh
    - Created setup_ui_layout function in bash_functions.sh
    - Created setup_admin_email function in bash_functions.sh
* Updated README.md
    - Added docs on new ENV Variables
    - Updated True/False settings docs so they were quoted, otherwise misleading to k8s users and not "true" booleans

Signed-off-by: Andrew J. Huffman <ahuffman@vmware.com>
2020-05-04 17:29:47 -04:00
Adam Hill 0570d264ed
Merge pull request #564 from losuler/dev
Fix minor spelling mistake
2020-02-16 13:01:36 -06:00
Adam Hill f0a9a9fb04
Merge pull request #565 from scott-kirk/patch-1
Minor spelling mistake in README
2020-02-09 12:46:43 -06:00
Scott Kirkpatrick bf0a9190c8
Minor spelling mistake in README 2020-02-09 11:19:04 -05:00
losuler 1add81a1ce Fix minor spelling mistake
Signed-off-by: losuler <losuler@users.noreply.github.com>
2020-02-09 17:27:48 +11:00
Warren Fisher 6e38238dc1 Add to Ubuntu install section
Add info about restarting systemd-resolved

Signed-off-by: Warren Fisher <github@warrenfisher.dev>

Add to Ubuntu install section

Signed-off-by: Warren Fisher <github@warrenfisher.dev>
2019-11-17 16:33:30 -04:00
Jeff Billimek 4dffbf031c Add new optional env variable DNS_FQDN_REQUIRED
This new optional env variable will allow control over the 'Never
forward non-FQDNs' advanced DNS setting.

Signed-off-by: Jeff Billimek <jeff@billimek.com>
2019-10-16 00:29:40 -04:00
Mitchel Humpherys b5356568d5 docker_run.sh: Add env var to specify storage directory
Currently `docker_run.sh` bind-mounts some directories rooted at the
working directory when the script is invoked.  Add an environment variable
so that this storage location can be specified at invocation time without
having to change to a different directory.

Also creates PIHOLE_BASE if it doesn't exist already.
2019-09-30 11:44:40 -07:00
kaysond e7174adaf1 Update README.md to include detailed Ubuntu install tips
Signed-off-by: kaysond <kaysond@hotmail.com>
2019-09-20 18:33:02 -07:00
Adam Hill 79ecb74140
Merge pull request #481 from danielhoherd/patch-1
Correct inconsistent indentation
2019-09-01 14:21:07 -05:00
Rui Marinho cec9ffb36b Add support for additional env var config 2019-08-31 19:17:19 +01:00
Alexis Lefebvre 226d7239e5
Fix typo s/equivilent/equivalent/ 2019-08-12 00:01:42 +02:00
Daniel fa044d0129 Correct inconsistent indentation
the contents of `volumes` was indented an extra space.

Signed-off-by: Daniel Hoherd <daniel.hoherd@gmail.com>
2019-07-06 10:09:33 -07:00
Adam Hill 7d36ab2ff9
Update README.md 2019-04-24 13:39:44 -05:00
Adam Hill 5f8b01bce3
Update README.md
Clarify that people running --net=host should set ServerIP for Pi-hole to function correctly.

I'll have to try to add some automation around this later to try to warn only the network host mode users if they miss it.
2019-04-24 13:37:45 -05:00
DK 2a973474fd
Fix typo
Pretty sure 54 is a typo and should be 53.
2019-04-15 09:06:29 -07:00
Adam Hill 95a665c057
Update README.md 2019-02-18 14:11:13 -06:00
Adam Hill e5ad7aea55
A bunch of readme tweaks
Signed-off-by: Adam Hill <adam@diginc.us>
2019-02-14 22:06:16 -06:00
Adam Hill 1685ed342f
Another flaky test, logs of readme
Signed-off-by: Adam Hill <adam@diginc.us>
2019-02-09 02:08:20 -06:00
Adam Hill fca7769b33
remove ServerIP requirement, simpler example commands
Signed-off-by: Adam Hill <adam@diginc.us>
2019-02-07 19:51:15 -06:00
Mathieu Hofman 6629aff889 Allow running pihole-FTL as non-root
- Add a new container environment variable allowing to specify the user to run the pihole-FTL process as. Defaults to root.
- Set inherited capabilities attributes on the pihole-FTL file to automatically grant runtime permitted capabilities when available in the bounding set. This allows dropping root before starting pihole-FTL without failing with a permission error if the capabilities are not available to the container (the process may still error out if performing an operation requiring the capability).
- Add some information on capabilities to the Readme file.

Signed-off-by: Mathieu Hofman <86499+mhofman@users.noreply.github.com>
2019-02-06 02:31:33 -08:00
Adam Hill 83cd82906d
Merge branch 'master' into vincent-extra-sleep 2019-01-13 13:49:37 -06:00
Vincent Perricone 403a205b2a Remove excess bash from Readme
Signed-off-by: Vincent Perricone <vhp@fastmail.fm>
2019-01-13 14:48:27 -05:00
Adam Hill 1c34c2a1ee
Fix extra tic in docker run, indendation
Signed-off-by: Adam Hill <adam@diginc.us>
2019-01-13 13:47:39 -06:00
Adam Hill a8e1746476
FTLDNS
Signed-off-by: Adam Hill <adam@diginc.us>
2019-01-13 13:02:20 -06:00
Vincent Perricone 98faf1e5f9 Move docker args to bottom for --env-file to put with other Optionals
Signed-off-by: Vincent Perricone <vhp@fastmail.fm>
2019-01-12 22:36:17 -05:00
Vincent Perricone c9050fef72 Update Readme
Signed-off-by: Vincent Perricone <vhp@fastmail.fm>
2019-01-12 22:34:02 -05:00