devmatteini / pihole-switch

A command line tool to enable/disable your pihole

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pihole Switch

CI GitHub release (latest by date)

A command line tool to enable/disable your pihole

Sometimes you just need to disable your pihole for some website to work. PiholeSwitch makes this operation much easier.

Just open a terminal, and you can disable pihole in a moment and for as long as you want.

Table of contents

Installation

Recommended

$ curl -s https://raw.githubusercontent.com/devmatteini/pihole-switch/main/install.sh | bash

Download the latest release and unzip the phs.zip file.

After the archive is unzipped, move the phs binary in a folder included in your $PATH (it's commonly used /usr/local/bin).

From DRA

Using dra you can download and install the latest release

$ dra download --install devmatteini/pihole-switch
$ ./phs --version

From source

git clone https://github.com/devmatteini/pihole-switch && cd pihole-switch
cargo build --release
./target/release/phs

Usage

Export an environment variable PIHOLE_TOKEN=<pihole_api_token>.

You can find the api token here: http://pi.hole/admin/settings.php?tab=api, then under the section Query log, click on the button Show API token and confirm.

Commands

Enable pihole

$ phs enable

Disable pihole (indefinitely)

$ phs disable

Disable pihole for 20 seconds

$ phs disable --time 20

If your device doesn't have pihole set as dns

$ phs --host 192.168.1.50 disable

(where 192.168.1.50 is the pihole ip address)

Enable/disable by passing the api token as an option, instead of using the PIHOLE_TOKEN environment variable

$ phs --token <token> <SUBCOMMAND>

Note: the api token passed as an option will always have priority on the PIHOLE_TOKEN environment variable

License

pihole-switch is made available under the terms of the MIT License.

See the MIT License file for license details.

About

A command line tool to enable/disable your pihole

License:MIT License


Languages

Language:Rust 93.0%Language:Shell 7.0%