Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to remove/replace outdated references #1099

Open
wants to merge 5 commits into
base: release/v6.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/ftldns/blockingmode.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Pi-hole *FTL*DNS currently supports the following modes for blocking queries:
Each mode has their advantages and drawbacks which will be discussed in detail below.

!!! note
In order to configure a blocking mode, you must edit the *FTL*DNS configuration file (`/etc/pihole/pihole-FTL.conf`). Once you've made any changes to the blocking mode, you must restart Pi-hole with `pihole restartdns`.
In order to configure a blocking mode, you must edit the *FTL*DNS configuration file (`/etc/pihole/pihole-FTL.conf`). Once you've made any changes to the blocking mode, you must restart Pi-hole FTL (e.g `sudo service pihole-FTL restart` `sudo systemctl restart pihole-FTL`).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In order to configure a blocking mode, you must edit the *FTL*DNS configuration file (`/etc/pihole/pihole-FTL.conf`). Once you've made any changes to the blocking mode, you must restart Pi-hole FTL (e.g `sudo service pihole-FTL restart` `sudo systemctl restart pihole-FTL`).
In order to configure a blocking mode, you must edit the *FTL*DNS configuration file (`/etc/pihole/pihole.toml`). Once you've made any changes to the blocking mode, you must restart Pi-hole FTL (e.g `sudo service pihole-FTL restart` `sudo systemctl restart pihole-FTL`).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already coming in the next commit... :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Happy to wait until you request review :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured I would go down a bit of a rabbit hole and try to update some of the outdated sections, too. In two minds about what to do with the ftldns/configfile/ page...

  1. Copy paste the current pihole.toml into this page as an online reference (with a reference to refer to the actual file for any up to date information
  2. Remove the page entirely
  3. (I know, I said two minds) put a small blurb about the existence of pihole.toml and that it is fully commented to describe each section (or to use the web interface)

Thoughts?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would go for three and add a link to https://ftl.pi-hole.net/master/docs/#get-/config (currently development) if users only want to get a list of possible config options.


## Pi-hole's unspecified IP or NULL blocking mode

Expand Down
2 changes: 1 addition & 1 deletion docs/ftldns/dnsmasq_warn.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Warnings commonly seen in `dnsmasq`'s log file (`/var/log/pihole/pihole.log`) an
edns-packet-max=1232
```

After running `pihole restartdns` your Pi-hole will not even try larger packet sizes (the default is 4096). Check out our [unbound guide](../guides/dns/unbound.md) for a comment about the particular value of `1232` or reference [this comment](https://discourse.pi-hole.net/t/dnsmasq-warn-reducing-dns-packet-size/51803/31) regarding the various allowed packet sizes for the various upstream DNS servers.
After restarting pihole-FTL it will not even try larger packet sizes (the default is 4096). Check out our [unbound guide](../guides/dns/unbound.md) for a comment about the particular value of `1232` or reference [this comment](https://discourse.pi-hole.net/t/dnsmasq-warn-reducing-dns-packet-size/51803/31) regarding the various allowed packet sizes for the various upstream DNS servers.

!!! warning "Ignoring query from non-local network"

Expand Down
2 changes: 1 addition & 1 deletion docs/group_management/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In this example, we describe how to set up a blocking rule for three specific cl
Don't forget to run

```bash
pihole restartdns reload-lists
pihole reloadlists
```

after your database modifications to have FTL flush its internal domain-blocking cache (separate from the DNS cache).
Expand Down
16 changes: 7 additions & 9 deletions docs/guides/misc/benchmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,19 @@ They are extracted into the list file as they are recorded in the database. Ther

We suggest disabling both logging and the long-term database during the benchmark run as both the log file and the database would otherwise unnecessarily grow, several hundred megabytes may be possible. Not only would your statistics be distorted by the artificial mass querying, but the benchmark could also be negatively affected by the writing speed of your SD card.

Logging can be disabled using `sudo pihole logging off`.
Logging can be disabled using `pihole-FTL --config dns.queryLogging false`.

The long-term database can be disabled by setting

```
DBFILE=
```

in `/etc/pihole/pihole-FTL.conf` and running `sudo pihole restartdns` (see also [here](../../ftldns/configfile.md/#dbfile)).
The long-term database can be disabled running `pihole-FTL --config files.database ""`

### 2.2 Increase DNS cache size

We also suggest increasing the DNS cache for benchmarking. The rather low value is fine for typical use cases. Domains will expire at some point and make room for new domains. As the benchmark will artificially increase the querying rate, there will be no time for the domains to expire naturally. This would dramatically hit the caching performance while you would never see such performance penalties in real use cases.

Set `cache-size` to a rather high value (maybe 25,000 - by guess roughly one-eighth to one-fourth number of the domains you extracted from the database in step 1) in `/etc/dnsmasq.d/01-pihole.conf` and run `sudo pihole restartdns` afterward.
Set the cache size to a rather high value (maybe 25,000 - by guess roughly one-eighth to one-fourth number of the domains you extracted from the database in step 1)

```bash
pihole-FTL --config dns.cache.size 25000
```

## 3. Query domains from the list

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/misc/tor/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If you want a recognizable hostname for the Tor DNS in your Pi-hole GUI statisti
Restart Pi-hole DNS Server for the `/etc/hosts` changes to take effect

```bash
sudo pihole restartdns
sudo service pihole-FTL restart
```

## Testing your configuration
Expand Down
11 changes: 0 additions & 11 deletions docs/main/pihole-command.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ Pi-hole makes use of many commands, and here we will break down those required t
| [Uninstall](#uninstall) | `pihole uninstall` |
| [Status](#status) | `pihole status` |
| [Enable & Disable](#enable-disable) | `pihole enable` <!-- markdownlint-disable-line MD051 --> |
| [Restart DNS](#restart-dns) | `pihole restartdns` |
| [Checkout](#checkout) | `pihole checkout` |

### Core Script
Expand Down Expand Up @@ -205,16 +204,6 @@ Display the running status of Pi-hole's DNS and blocking services.

Toggle Pi-hole's ability to block unwanted domains. The disable option has the option to set a specified time before blocking is automatically re-enabled.

### Restart DNS

| | |
| -------------- | -------------- |
| Help Command | N/A |
| Script Location | [`/usr/local/bin/pihole`](https://github.com/pi-hole/pi-hole/blob/master/pihole) |
| Example Usage | [`pihole restartdns`](https://discourse.pi-hole.net/t/the-pihole-command-with-examples/738#restartdns) |

Restart Pi-hole's DNS service.

### Checkout

| | |
Expand Down
4 changes: 2 additions & 2 deletions docs/regex/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ There are two locations where regex filters are important:
*FTL*DNS reads in regular expression filters from the two [`regex` database views](../database/domain-database/index.md).
To tell *FTL*DNS to reload the list of regex filters, either:

- Execute `pihole restartdns reload-lists` or
- Execute `pihole reloadlists` or
- Send `SIGHUP` to `pihole-FTL` (`sudo killall -SIGHUP pihole-FTL`) or
- Restart the service (`sudo service pihole-FTL restart`)
- Restart the service (`sudo service pihole-FTL restart` or `sudo systemctl restart pihole-FTL`)

The first command is to be preferred as it ensures that the DNS cache itself remains intact. Hence, it is also the fastest of the available options.

Expand Down