PiPass

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.

PiPass blockpage

Contributing

Obviously, this is an open-source project. 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.

Prerequisites

Pi-Hole server
- Includes webserver and PHP already installed & configured (confirmed working on PHP version 7.3)
SSH or direct terminal access
SSL certificate for your Pi-Hole (self signed is ok)
PHP-CURL to check for new versions (sudo apt update && sudo apt install php7.0-curl) Root (sudo) access to Pi-Hole
Git (if this isn't installed yet, use sudo apt-get install wget git-core)
Knowledge of location of webroot (normaly this can be found under /var/www/html/)
Webroot folder without any index files (e.g. no index.php/index.html/etc.)
Knowledge of which user PHP is running as
Optional: Domain or subdomain linked to your Pi-Hole

Install

NOTE: Versions 1.2/1.2b and below are now deprecated due to not having automatic update checking functionality. Please update immediately by removing your current installation and following this much simpler setup guide.

Make your webserver redirect all 404 errors to the webroot.
PiHole uses lighttpd as a webserver by default. As such, this installer will configure 404 redirects for it by default. Other web servers will need to configure this manually.

For nginx, this is

        location / {
                try_files $uri $uri/ =404;
                error_page 404 =200 http://$host;
        }

Execute cd ~/ && wget -O setup.php https://apps.roen.us/pipass/setup && sudo php setup.php to download the setup script and rename it.
Fill out the config.php configuration file.

Support

Having problems? Let me know.

Pull requests are welcome!

Known Caveats

Requires webroot index
Requires end-user to (sometimes) clear their DNS cache
Does not work on websites with HSTS header cached :(

Future Ideas

Ability to trigger permanent whitelist after password entry
Admin console for PiPass
apt repository/package

EpicKitten / PiPass