You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+148-44
Original file line number
Diff line number
Diff line change
@@ -7,68 +7,172 @@ PADD (formerly Chronometer2) is a more expansive version of the original chronom
7
7
***Note:** PADD has been adopted by the Pi-hole team, thanks to JPMCK for creating this helpful tool!
8
8
9
9
## Setup PADD
10
-
*More in-depth information about setting up PADD can be found in this repo’s [wiki](https://github.com/pi-hole/PADD/wiki/Setup).*
11
10
12
11
- Get a copy of PADD by running:
13
12
14
-
```bash
15
-
cd~
16
-
wget -O padd.sh https://install.padd.sh
17
-
```
18
-
or
19
-
```bash
20
-
cd~
21
-
curl -sSL https://install.padd.sh -o padd.sh
22
-
```
13
+
```bash
14
+
cd~
15
+
wget -O padd.sh https://install.padd.sh
16
+
```
17
+
18
+
or
19
+
20
+
```bash
21
+
cd~
22
+
curl -sSL https://install.padd.sh -o padd.sh
23
+
```
23
24
24
25
- Make PADD executable by running
25
26
26
-
```bash
27
-
sudo chmod +x padd.sh
28
-
```
27
+
```bash
28
+
sudo chmod +x padd.sh
29
+
```
29
30
30
-
- Set PADD to auto run by adding the following to the end of `~/.bashrc`:
31
+
## Using PADD
31
32
32
-
```bash
33
-
# Run PADD
34
-
# If we’re on the PiTFT screen (ssh is xterm)
35
-
if [ "$TERM"=="linux" ] ;then
36
-
while:
37
-
do
38
-
./padd.sh
39
-
sleep 1
40
-
done
41
-
fi
42
-
```
33
+
### PADD on Pi-hole machine
43
34
44
-
One line version
35
+
- Just run
45
36
46
-
```bash
47
-
cd~;echo"if [ \"\$TERM\" == \"linux\" ] ; then\n while :\n do\n ./padd.sh\n sleep 1\n done\nfi"| tee ~/.bashrc -a
48
-
```
37
+
```bash
38
+
./padd.sh
39
+
```
40
+
41
+
### PADD from other machine
42
+
43
+
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
44
+
45
+
```bash
46
+
./padd.sh --server <DOMAIN|IP>
47
+
```
48
+
49
+
### Authentication
50
+
51
+
Pi-hole v6 uses a completely new API with a new authentication mechanism
52
+
53
+
If you run PADD on the same machine as Pi-hole, it's possible to bypass authentication when your local user is member of the `pihole` group (specifically, if you can access `/etc/pihole/cli_pw).
54
+
For details see [https://github.com/pi-hole/FTL/pull/1999](https://github.com/pi-hole/FTL/pull/1999)
55
+
56
+
If this is not the case, PADD will ask you for your password and (if configured) your two factor authentication token. You can also pass those as arguments
57
+
58
+
- password only
59
+
60
+
```bash
61
+
./padd.sh --secret <password>
62
+
```
63
+
64
+
- with 2FA enabled
65
+
66
+
```bash
67
+
./padd.sh --secret <password> --2fa <2fa>
68
+
```
69
+
70
+
### PADD with Pi-hole in a Docker Container
71
+
72
+
- 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:
_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)_
81
+
82
+
- Set PADD to auto run on the PiTFT screen by adding the following to the end of `~/.bashrc`:
49
83
50
-
- Reboot your Pi-Hole by running `sudo reboot`. PADD should now run when your Pi-Hole has completed booting.
84
+
```bash
85
+
# Run PADD
86
+
# If we’re on the PiTFT screen (ssh is xterm)
87
+
if [ "$TERM"=="linux" ] ;then
88
+
while:
89
+
do
90
+
./padd.sh
91
+
sleep 1
92
+
done
93
+
fi
94
+
```
95
+
96
+
One line version
97
+
98
+
```bash
99
+
cd~;echo"if [ \"\$TERM\" == \"linux\" ] ; then\n while :\n do\n ./padd.sh\n sleep 1\n done\nfi"| tee ~/.bashrc -a
100
+
```
101
+
102
+
- Reboot your Pi-Hole by running `sudo reboot`. PADD should now run on PiTFT Screen when your Pi-Hole has completed booting.
103
+
104
+
#### (Optional) Put the PiTFT Display to Sleep at Night
105
+
106
+
_If you don't want your PiTFT on all night when you are asleep, you can put it to sleep! (Note: **these instructions only apply to a PiTFT**.)_
107
+
108
+
- To do so, edit cron as root (`sudo crontab -e`) and add the following:
109
+
110
+
```bash
111
+
# PiTFT+ SLEEPY TIME
112
+
# Turn off the PiTFT+ at midnight
113
+
00 00 *** sh -c 'echo "0" > /sys/class/backlight/soc\:backlight/brightness'
114
+
# Turn on the PiTFT+ at 8:00 am
115
+
00 08 *** sh -c 'echo "1" > /sys/class/backlight/soc\:backlight/brightness'
116
+
```
51
117
52
118
## Updating PADD
119
+
53
120
- Simply run
54
121
55
-
```bash
56
-
./padd.sh -u
57
-
```
122
+
```bash
123
+
./padd.sh -u
124
+
```
58
125
59
126
- or run the same commands you used to install
60
127
61
-
```bash
62
-
cd~
63
-
wget -O padd.sh https://install.padd.sh
64
-
```
65
-
```bash
66
-
cd~
67
-
curl -sSL https://install.padd.sh -o padd.sh
68
-
```
128
+
```bash
129
+
cd~
130
+
wget -O padd.sh https://install.padd.sh
131
+
```
132
+
133
+
or
134
+
135
+
```bash
136
+
cd~
137
+
curl -sSL https://install.padd.sh -o padd.sh
138
+
```
139
+
140
+
## Sizes
141
+
142
+
PADD will display on screens that anywhere from 20x10 characters to over 80x26 characters.
143
+
144
+
As your screen gets smaller, you’ll be presented with less information… however, you’ll always get the most important details:
145
+
146
+
- The status of your Pi-hole (is it online, in need of an update?),
147
+
- How many ads have been blocked,
148
+
- Your hostname and IP, and
149
+
- Your CPU’s current load.
150
+
151
+
It will also run in the following modes (shown further below):
152
+
153
+
- Pico: 20x10 characters
154
+
- Nano: 24x12 characters
155
+
- Micro: 30x16 characters
156
+
- Mini: 40x18 characters
157
+
- Tiny: 53x20 characters
158
+
- Slim: 60x21 characters
159
+
- Regular: 60x22 characters (takes up the entire screen on a 3.5" Adafruit PiTFT using the Terminal font at 8x14.)
160
+
- Mega: 80x26 characters
161
+
162
+
### Sizing Your PADD
163
+
164
+
How PADD will display on your screen depends on the size of the screen in _characters_, not _pixels_! PADD doesn’t care if it is running on a 5k Retina display on your $5,000 iMac Pro or on a $5 display you bought on eBay.
165
+
166
+
If you want to change how PADD displays on a small display attached to your Raspberry Pi, use
69
167
70
-
## Running Pi-hole in a Docker Container
71
-
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:
to configure your font settings to an ideal size for you.
173
+
174
+
If you want to change how PADD displays through a terminal emulator (PuTTY, Terminal.app, iTerm2, etc.), resize your window or play with font sizes in your app of choice.
0 commit comments