Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Woolweaver <[email protected]>
  • Loading branch information
mwoolweaver authored Feb 16, 2025
1 parent 554d548 commit 3aa77e6
Showing 1 changed file with 20 additions and 23 deletions.
43 changes: 20 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,33 @@ PADD (formerly Chronometer2) is a more expansive version of the original chronom

## Using PADD

- Run PADD from Pi-hole
### PADD on Pi-hole machine
<!-- See https://github.com/pi-hole/FTL/pull/1999 for why i worded it this way -->
- if running as user belonging to the group `pihole` (if not use `sudo`)
```bash
./padd.sh
```

- PADD help
### PADD from other machine
With PADD v4.0.0 and Pi-hole v6 it is also possible to run PADD from a machine that is not running Pi-hole

- without 2FA enabled
```bash
./padd.sh --server <DOMAIN|IP> --secret <password>
```

- with 2FA enabled
```bash
./padd.sh --server <DOMAIN|IP> --secret <password> --2fa <2fa>
```

### PADD with 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
./padd.sh --help
docker exec -it <container_name> padd [padd_options]
```
### PADD on PiTFT screen
### PADD on PiTFT screen
_Instructions for how to setup PiTFT screen can be found [here](https://learn.adafruit.com/adafruit-pitft-3-dot-5-touch-screen-for-raspberry-pi/easy-install-2)_
- Set PADD to auto run on the PiTFT screen by adding the following to the end of `~/.bashrc`:
Expand Down Expand Up @@ -87,25 +103,6 @@ PADD (formerly Chronometer2) is a more expansive version of the original chronom
curl -sSL https://install.padd.sh -o padd.sh
```

## 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]
```

## Running PADD from other machine
With PADD v4.0.0 and Pi-hole v6 it is also possible to run PADD from a machine that is not running Pi-hole

- Run PADD from other machine without 2FA
```bash
./padd.sh --server <DOMAIN|IP> --secret <password>
```

- Run PADD from other machine with 2FA enabled
```bash
./padd.sh --server <DOMAIN|IP> --secret <password> --2fa <2fa>
```

## Sizes
PADD will display on screens that anywhere from 20x10 characters to over 80x26 characters.

Expand Down

0 comments on commit 3aa77e6

Please sign in to comment.