diff --git a/README.md b/README.md index 9a67f59..bffbbd3 100644 --- a/README.md +++ b/README.md @@ -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 + +- 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 --secret + ``` + + - with 2FA enabled + ```bash + ./padd.sh --server --secret --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 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`: @@ -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 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 --secret - ``` - -- Run PADD from other machine with 2FA enabled - ```bash - ./padd.sh --server --secret --2fa <2fa> - ``` - ## Sizes PADD will display on screens that anywhere from 20x10 characters to over 80x26 characters.