Skip to content

Commit 234883c

Browse files
authored
restore steps component (#23)
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parent 4afa895 commit 234883c

File tree

8 files changed

+80
-56
lines changed

8 files changed

+80
-56
lines changed

src/content/docs/pi-hole/block-allow-lists.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ HaGeZi already includes these as upstream sources.
8787
They can create duplicate entries without providing additional coverage.
8888
Pi-hole deduplicates during Gravity updates so it won't break anything, but it's unnecessary weight.
8989

90-
{/* <Steps> */}
90+
<Steps>
9191

9292
1. Choose one core HaGeZi list:
9393

@@ -159,13 +159,13 @@ Pi-hole deduplicates during Gravity updates so it won't break anything, but it's
159159
https://blocklistproject.github.io/Lists/phishing.txt
160160
```
161161

162-
{/* </Steps> */}
162+
</Steps>
163163

164164
## Add Blocklists to Pi-hole
165165

166166
To add a list:
167167

168-
{/* <Steps> */}
168+
<Steps>
169169

170170
1. Log in to the Pi-hole web interface at `https://pi-hole.local/admin`.
171171
1. Go to **Lists**.
@@ -178,7 +178,7 @@ To add a list:
178178

179179
Gravity also runs automatically on a weekly schedule.
180180

181-
{/* </Steps> */}
181+
</Steps>
182182

183183
## Add Allowlists and Domains to Pi-hole
184184

@@ -194,7 +194,7 @@ There are two ways to allowlist in Pi-hole v6:
194194
The HaGeZi Referral Allowlist is a maintained collection of domains that blocklists commonly block but that services legitimately need.
195195
Adding it as a subscription prevents a large category of false positives before they happen.
196196

197-
{/* <Steps> */}
197+
<Steps>
198198

199199
1. In the Pi-hole web interface, go to **Lists**.
200200
1. Paste the allowlist:
@@ -212,7 +212,7 @@ Adding it as a subscription prevents a large category of false positives before
212212

213213
Gravity also runs automatically on a weekly schedule.
214214

215-
{/* </Steps> */}
215+
</Steps>
216216

217217
### Add an Individual Domain to the Allowlist
218218

@@ -340,7 +340,7 @@ A device can be added to multiple groups at the same time and will follow the co
340340

341341
Useful for a device where blocking breaks functionality and you can't or would rather not troubleshoot it (smart TVs, streaming sticks, Paramount+, Roku).
342342

343-
{/* <Steps> */}
343+
<Steps>
344344

345345
1. Find the device's IP address in **Tools** > **Network** or based on its traffic in the **Query Log**.
346346

@@ -353,7 +353,7 @@ Useful for a device where blocking breaks functionality and you can't or would r
353353

354354
1. Select **Add**.
355355

356-
{/* </Steps> */}
356+
</Steps>
357357

358358
The device now resolves DNS without any filtering.
359359
All other devices are unaffected.
@@ -363,7 +363,7 @@ All other devices are unaffected.
363363
Apply extra blocklists on top of the normal ones without affecting the rest of the network.
364364
This can be useful for a child's device or a school-issued laptop.
365365

366-
{/* <Steps> */}
366+
<Steps>
367367

368368
1. Confirm that the device's network traffic isn't being routed through a VPN.
369369

@@ -399,7 +399,7 @@ This can be useful for a child's device or a school-issued laptop.
399399

400400
1. Select **Add**.
401401

402-
{/* </Steps> */}
402+
</Steps>
403403

404404
The device is now blocked by everything in `Default` as well as the extra lists.
405405
Other devices that are not in the new group are unaffected.

src/content/docs/pi-hole/install-configure.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,21 @@ brew install sdformatter raspberry-pi-imager
3737
This process erases everything on the SD card.
3838
:::
3939

40-
{/* <Steps> */}
40+
<Steps>
4141

4242
1. Insert a microSD card, then open SD Card Formatter and choose the card from the **Select card** dropdown.
4343
1. Select **Format** to format the card.
4444
- The default settings are fine: Quick format and no volume label.
4545
1. Exit SD Card Formatter and leave the SD card inserted.
4646

47-
{/* </Steps> */}
47+
</Steps>
4848

4949
## Create the Pi OS Image on the SD Card
5050

5151
Raspberry Pi Imager makes the SD card a bootable drive.
5252
After you set up the SD card, you'll install it in the Raspberry Pi as its primary drive.
5353

54-
{/* <Steps> */}
54+
<Steps>
5555

5656
1. Open Raspberry Pi Imager.
5757
1. **Select your Raspberry Pi Device**: Raspberry Pi 4.
@@ -74,7 +74,7 @@ After you set up the SD card, you'll install it in the Raspberry Pi as its prima
7474
1. When the write completes, remove the SD card from your computer and insert it into the Raspberry Pi.
7575
1. Plug in the Pi and give it a few minutes to boot.
7676

77-
{/* </Steps> */}
77+
</Steps>
7878

7979
<details>
8080
<summary>Rebuilds and Upgrades: Confirm Your Linux Version</summary>
@@ -92,7 +92,7 @@ PRETTY_NAME="Debian GNU/Linux 13 (trixie)"
9292

9393
## Configure Raspberry Pi OS
9494

95-
{/* <Steps> */}
95+
<Steps>
9696

9797
1. Find the Pi's IP Address:
9898

@@ -148,14 +148,14 @@ PRETTY_NAME="Debian GNU/Linux 13 (trixie)"
148148
ip addr show eth0
149149
```
150150

151-
{/* </Steps> */}
151+
</Steps>
152152

153153
#### TP-Link Omada-specific steps to find and fix the Pi's IP
154154

155155
<details>
156156
<summary>Find the Pi and set a fixed IP on a TP-Link Omada controller</summary>
157157

158-
{/* <Steps> */}
158+
<Steps>
159159

160160
1. Log in and select the site's name.
161161
1. Select **Clients** then **Wired** to filter the table of connected clients.
@@ -165,7 +165,7 @@ PRETTY_NAME="Debian GNU/Linux 13 (trixie)"
165165

166166
You should still follow the steps in the [Set a Static IP](#set-a-static-ip-address) section when you get there.
167167

168-
{/* </Steps> */}
168+
</Steps>
169169

170170
![Set fixed IP in Omada controller](./screenshots/omada-fixed-ip-address.png)
171171

@@ -178,7 +178,7 @@ The non-root user that Raspberry Pi Imager created can run `sudo` commands witho
178178
Raspberry Pi Imager creates a configuration file to enforce passwordless `sudo`.
179179
Remove the file so that sudo commands require authentication.
180180

181-
{/* <Steps> */}
181+
<Steps>
182182

183183
1. Remove the configuration file:
184184

@@ -193,15 +193,15 @@ Remove the file so that sudo commands require authentication.
193193
ssh pi-admin@pi-hole.local
194194
```
195195

196-
{/* </Steps> */}
196+
</Steps>
197197

198198
### Set Up a Firewall on Your Pi With UFW
199199

200200
UFW (Uncomplicated Firewall) restricts which ports are accessible on the Pi.
201201
Pi-hole requires ports for DNS and the web interface.
202202
SSH is allowed for remote administration.
203203

204-
{/* <Steps> */}
204+
<Steps>
205205

206206
1. Install UFW:
207207

@@ -255,7 +255,7 @@ SSH is allowed for remote administration.
255255
sudo ufw status
256256
```
257257

258-
{/* </Steps> */}
258+
</Steps>
259259

260260
<details>
261261
<summary>If you plan to use Pi-hole as a DHCP server</summary>
@@ -275,7 +275,7 @@ sudo ufw allow 67/udp comment 'DHCP'
275275
Fail2Ban automatically bans IPs that fail too many login attempts.
276276
This helps minimize the risk of brute-force attacks.
277277

278-
{/* <Steps> */}
278+
<Steps>
279279

280280
1. Install Fail2Ban:
281281

@@ -312,7 +312,7 @@ This helps minimize the risk of brute-force attacks.
312312

313313
You should see the jail listed as active with 0 currently banned IPs on a fresh install.
314314

315-
{/* </Steps> */}
315+
</Steps>
316316

317317
### Set a Static IP Address
318318

@@ -323,7 +323,7 @@ These steps use `nmcli` to lock the IP.
323323
They set the Ethernet connection name as a temporary shell variable.
324324
The variable is cleared when you exit the session.
325325

326-
{/* <Steps> */}
326+
<Steps>
327327

328328
1. Set the static IP, gateway, and DNS.
329329

@@ -389,7 +389,7 @@ The variable is cleared when you exit the session.
389389

390390
Wait a few minutes before you SSH back in.
391391

392-
{/* </Steps> */}
392+
</Steps>
393393

394394
## Checkpoint
395395

src/content/docs/pi-hole/maintenance.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ sudo pihole -g
3434

3535
Pi-hole's Teleporter exports your full configuration: blocklists, allowlists, custom domains, regex rules, DNS settings, and DHCP config.
3636

37-
{/* <Steps> */}
37+
<Steps>
3838

3939
1. In the Pi-hole web interface, go to **Settings** > **Teleporter**.
4040
1. Select **Export** to download a backup file.
4141

42-
{/* </Steps> */}
42+
</Steps>
4343

4444
To restore after a rebuild or SD card failure, use the **Import** option on the same page and select the backup file.
4545

@@ -107,7 +107,7 @@ Move the database and log file to a USB drive to protect the SD card and extend
107107

108108
### Mount the USB drive
109109

110-
{/* <Steps> */}
110+
<Steps>
111111

112112
1. Plug in the USB drive and find its device name:
113113

@@ -166,11 +166,11 @@ Move the database and log file to a USB drive to protect the SD card and extend
166166
sudo chown pihole:pihole /mnt/pihole-logs
167167
```
168168

169-
{/* </Steps> */}
169+
</Steps>
170170

171171
### Point Pi-hole to the USB drive
172172

173-
{/* <Steps> */}
173+
<Steps>
174174

175175
1. Back up the current `pihole.toml`:
176176

@@ -226,14 +226,16 @@ Move the database and log file to a USB drive to protect the SD card and extend
226226
The FTL service won't start if it can't find the database file.
227227
DNS queries from all network devices will fail until the mount is fixed.
228228

229-
{/* </Steps> */}
229+
</Steps>
230230

231231
### Optional: Set Pi-hole database retention
232232

233233
By default, Pi-hole keeps 91 days of query history.
234234

235235
If you want to change the database size:
236236

237+
<Steps>
238+
237239
1. Set a the number of days to keep the database in `pihole.toml`:
238240

239241
```toml title="pihole.toml"
@@ -246,3 +248,5 @@ If you want to change the database size:
246248
```shell title="From the Pi"
247249
sudo systemctl restart pihole-FTL
248250
```
251+
252+
</Steps>

src/content/docs/pi-hole/network-level-blocking.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Look for **DHCP**, **LAN**, or **DNS** settings.
4040

4141
![Omada controller DNS server settings](./screenshots/omada-dns-server-settings.png)
4242

43-
{/* <Steps> */}
43+
<Steps>
4444

4545
1. Log in to the Omada controller and select the site's name.
4646
1. In the sidebar, under **Configuration**, select **Network Config** > **LAN**.
@@ -51,7 +51,7 @@ Look for **DHCP**, **LAN**, or **DNS** settings.
5151
1. In the second box, enter `1.1.1.1` to use Cloudflare as a backup DNS server.
5252
1. Select **Next** to save and apply the settings.
5353

54-
{/* </Steps> */}
54+
</Steps>
5555

5656
After you save the settings, devices need to renew their DHCP lease to pick up the new DNS server.
5757
This happens automatically when the lease expires (typically within 24 hours, depending on your router), or immediately if you disconnect and reconnect Wi-Fi, or restart the device.
@@ -68,7 +68,7 @@ Some smart devices like Chromecast and Samsung Smart TVs ignore the DNS server y
6868
- **Samsung Smart TVs** may use `8.8.8.8` for some services even when a different DNS is assigned.
6969
- **Android and iOS** support encrypted DNS (DNS-over-HTTPS or DNS-over-TLS), which can send queries directly to Google or Cloudflare, bypassing Pi-hole completely.
7070

71-
{/* <Steps> */}
71+
<Steps>
7272

7373
1. To force traffic from these devices through the Pi-hole, add NAT rules that intercept all outbound DNS on port 53.
7474

@@ -97,7 +97,7 @@ Some smart devices like Chromecast and Samsung Smart TVs ignore the DNS server y
9797

9898
You should see two rules with `DNAT` and `to:YOUR-PI-IP` — one for `udp dpt:domain` and one for `tcp dpt:domain`.
9999

100-
{/* </Steps> */}
100+
</Steps>
101101

102102
To verify a specific device is now routing through Pi-hole, check the query log at `https://pi-hole.local/admin/queries` and filter by that device's IP.
103103
You should see its DNS requests appearing there.

src/content/docs/pi-hole/pihole-install.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ If you installed Pi-hole on an existing device or skipped to this section, these
2727

2828
</details>
2929

30-
{/* <Steps> */}
30+
<Steps>
3131

3232
1. SSH to the Pi:
3333

@@ -80,7 +80,7 @@ If you installed Pi-hole on an existing device or skipped to this section, these
8080

8181
If you don't see the option to proceed, refresh the page.
8282

83-
{/* </Steps> */}
83+
</Steps>
8484

8585
## Optional: Configure Unbound as Recursive DNS
8686

@@ -91,7 +91,7 @@ This means no single upstream provider sees all your DNS queries.
9191
Pi-hole works well with Cloudflare.
9292
Add unbound if you prefer the additional privacy of recursive resolution.
9393

94-
{/* <Steps> */}
94+
<Steps>
9595

9696
1. Install unbound, then immediately stop it so that you can set your own configuration:
9797

@@ -167,7 +167,7 @@ Add unbound if you prefer the additional privacy of recursive resolution.
167167
You should see a `NOERROR` status.
168168
The first query may be slow as unbound builds its cache.
169169

170-
{/* </Steps> */}
170+
</Steps>
171171

172172
:::caution["port 53: Address in use"]
173173
If you install unbound and don't stop it right away, it will self-assign port 53 and conflict with the Pi-hole.
@@ -191,7 +191,7 @@ It shows query rate, cache hits, blocked domains, and FTL status alongside syste
191191
The Pi-hole web interface already shows DNS stats.
192192
Add Netdata if you want system-level metrics alongside your Pi-hole data.
193193

194-
{/* <Steps> */}
194+
<Steps>
195195

196196
1. Install Netdata:
197197

@@ -238,7 +238,7 @@ Add Netdata if you want system-level metrics alongside your Pi-hole data.
238238

239239
The **Fail2Ban** section will appear in the dashboard showing currently banned IPs and active failures for each jail.
240240

241-
{/* </Steps> */}
241+
</Steps>
242242

243243
## Checkpoint
244244

0 commit comments

Comments
 (0)