More readme.md

This commit is contained in:
Jez Caudle 2024-02-01 12:04:53 +00:00
parent d0a51f239a
commit 2557a5b47f

View File

@ -106,39 +106,14 @@ to 'announce@geoghegan.ca' with a subject line and body of "subscribe pf-badhost
## Post Install Notes: ## Post Install Notes:
X) To add custom rules or enable features, or add alternate blocklists, To add custom rules or enable features, or add alternate blocklists, see the "User Configuration Area" located at the top of the script. This area serves as a built in config file, so please feel free to edit it and experiment with all the features available within. Note: Most options can also be configured from the command line
See the "User Configuration Area" located at the top of the script.
This area serves as a built in config file, so please feel free to
edit it and experiment with all the features available within.
---
Note: Most options can also be configured from the command line
X) Regarding Cron Jobs: Regarding Cron Jobs - over the past year I've noticed a number of list host servers going down at midnight in populated timezones (ie West Coast, East Coast and Western Europe). To be respectful (and to avoid overloading list providers servers) we have cron jobs scheduled to run at a random time within a defined interval. With the new default cron job, pf-badhost will be run every night at some point between midnight and 2AM, and thus distributing the load of thousands of queries from numerous users over a 2 hour period rather than a matter of seconds.
Over the past year I've noticed a number of list host servers
going down at midnight in populated timezones (ie West Coast,
East Coast and Western Europe). To be respectful (and to avoid
overloading list providers servers) we have cron jobs
scheduled to run at a random time within a defined interval.
---
With the new default cron job, pf-badhost will be run every
night at some point between midnight and 2AM, and thus
distributing the load of thousands of queries from numerous
users over a 2 hour period rather than a matter of seconds.
1) The script is able to detect which (if any) subnet aggregation utilities are The script is able to detect which (if any) subnet aggregation utilities are installed and will try to "Do The Right Thing(tm)" and fallback to the best available option. If no subnet aggregation utility is found, the script will fallback to using a pure Perl IPv4 aggregator if Perl is installed. Despite its name, "aggregate6" supports both IPv4 and IPv6 addresses and is written in Python, whereas the "aggregate" utility supports only IPv4 addresses and is written in C and uses significantly less memory but runs much slower. For greatly improved performance, aggregate6 can be run with Pypy. If both utilities are installed, the C based "aggregate" utility will be preferred for IPv4 aggregation, but the script will happily function if only one or the other is installed (or neither).
installed and will try to "Do The Right Thing(tm)" and fallback to the best
available option. If no subnet aggregation utility is found, the script Note: Subnet aggregation can be enabled with the '-A' switch on the commandline.
will fallback to using a pure Perl IPv4 aggregator if Perl is installed.
Despite its name, "aggregate6" supports both IPv4 and IPv6 addresses and is
written in Python, whereas the "aggregate" utility supports only IPv4
addresses and is written in C and uses significantly less memory but runs much
slower. For greatly improved performance, aggregate6 can be run with Pypy.
If both utilities are installed, the C based "aggregate" utility will be
preferred for IPv4 aggregation, but the script will happily function if only
one or the other is installed (or neither).
---
Note: Subnet aggregation can be enabled with the '-A' switch on the commandline.
* "aggregate" can be installed via: # pkg_add aggregate * "aggregate" can be installed via: # pkg_add aggregate
* "aggregate6" can be installed via: # pkg_add aggregate6 * "aggregate6" can be installed via: # pkg_add aggregate6