Stars: 197
Forks: 13
Pull Requests: 17
Issues: 61
Watchers: 11
Last Updated: 2020-09-11 06:54:21
A temporary unblock solution and blockpage for your Pi-Hole system
License: BSD 3-Clause "New" or "Revised" License
Languages: PHP
PiPass is an extention to the Pi-Hole project which adds easy temporary unblocking functionality and a visually appealing blockpage. The whole project currently is written in PHP, so it will integrate very easily with your existing Pi-Hole system. The blockpage is very easy to use, presenting three distinct options, an automated, temporary unblock button among them.
Installation on a vanilla Pi-Hole is completely automated. Execute bash <(wget -qO- https://sputnik.roen.us/pipass/scripts/install.sh)
to install, and you should be done. Please make sure you have php-curl installed before running the install. Install it by executing sudo apt update && sudo apt install -y php-curl
.
If you have a more complex installation (e.g. using NGiNX
as a webserver), follow these steps below.
lighttpd
, this function is automated.For NGiNX
, this is
location / {
try_files $uri $uri/ =404;
error_page 404 =200 http://$host;
}
bash <(wget -qO- https://sputnik.roen.us/pipass/scripts/install.sh)
- You may be prompted for elevated permissions using sudo
.
Optional: fill out the config.php
configuration file.
PiPass is an open-source project and relies on community support to stay alive. You may find problems in the code, in which I would strongly encourage you to create an issue, or if you're willing to solve it yourself, fork the repository and create a pull request. If you want a feature added, feel free to create an issue.
A list of known caveats is at the bottom of this document. If you'd like to contribute but don't know how, check there for some ideas.
Having problems? Let me know.
Do not ask questions in Pi-Hole communities as PiPass is a separate project.
Pull requests are welcome!