Files
PADD/README.md
thomasmerz 94d4e2e635 Update README.md
Co-authored-by: Adam Warner <github@adamwarner.co.uk>
Signed-off-by: thomasmerz <thomasmerz@users.noreply.github.com>
2022-12-27 12:43:58 +01:00

64 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# PADD
PADD (formerly Chronometer2) is a more expansive version of the original chronometer.sh that is included with [Pi-Hole](https://pi-hole.net). PADD provides in-depth information about your Pi-hole.
![PADD Screenshot](https://pi-hole.github.io/graphics/Screenshots/padd.png)
***Note:** PADD has been adopted by the Pi-hole team, thanks to JPMCK for creating this helpful tool!
## Setup PADD
*More in-depth information about setting up PADD can be found in this repos [wiki](https://github.com/jpmck/PADD/wiki/Setup).*
- Get a copy of PADD by running:
```bash
cd ~
wget -N https://raw.githubusercontent.com/pi-hole/PADD/master/padd.sh
```
- Make PADD executable by running
```bash
sudo chmod +x padd.sh
```
- Set PADD to auto run by adding the following to the end of `~/.bashrc`:
```bash
# Run PADD
# If were on the PiTFT screen (ssh is xterm)
if [ "$TERM" == "linux" ] ; then
while :
do
./padd.sh
sleep 1
done
fi
```
One line version
```bash
cd ~ ; echo "if [ \"\$TERM\" == \"linux\" ] ; then\n while :\n do\n ./padd.sh\n sleep 1\n done\nfi" | tee ~/.bashrc -a
```
- Reboot your Pi-Hole by running `sudo reboot`. PADD should now run when your Pi-Hole has completed booting.
## Updating PADD
- Just run
```bash
cd ~
wget -N https://raw.githubusercontent.com/pi-hole/PADD/master/padd.sh
```
**Note: if you are already running Chronometer2 v1.3.1 or below, youll need to follow [these instructions](https://github.com/jpmck/PADD/wiki/Updating-from-Chronometer2)!**
## Running Pi-hole in a Docker Container
If you're running Pi-hole in the official Docker Container, `padd.sh` is pre-installed and named `padd`. It can be used with the following command:
```bash
docker exec -it <container_name> padd [padd_options]
```