nezumi/cloudflare-gateway-pihole-scripts
1
0
Fork 0
mirror of https://github.com/Nezumi-2711/cloudflare-gateway-pihole-scripts.git synced 2026-09-22 13:38:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

improve whitelist documentation

Browse Source 
adds 'whitelist support' to feature list, and clarifies how to use the whitelist
This commit is contained in:
mrrfv
2023-05-15 15:00:02 +02:00
committed by GitHub
parent 8939843a8b
commit 8b065e98d7
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -1
View File
@@ -17,6 +17,7 @@ Cloudflare Gateway allows you to create custom rules to filter HTTP, DNS, and ne
- Full support for domain lists
- Automatically cleans up filter lists: removes duplicates, invalid domains, comments and more
- Works fully unattended
- Whitelist support, allowing you to prevent false positives and breakage by forcing trusted domains to always be unblocked.
## Usage
@@ -26,7 +27,7 @@ Cloudflare Gateway allows you to create custom rules to filter HTTP, DNS, and ne
2. Cloudflare [Zero Trust](https://one.dash.cloudflare.com/) account - the Free plan is enough. Use the Cloudflare [documentation](https://developers.cloudflare.com/cloudflare-one/) for details.
3. Cloudflare email, API key (NOT the API token), and account ID
4. A file containing the domains you want to block - **max 300,000 domains for the free plan** - in the working directory named `input.csv`. Mullvad provides awesome [DNS blocklists](https://github.com/mullvad/dns-blocklists) that work well with this project. A bash script that downloads recommended blocklists, `get_recommended_filters.sh`, is included.
5. Optional: You can add whitelist domains to the `get_recomended_whitelist.sh` if you wish.
5. Optional: You can whitelist domains by putting them in a file `whitelist.csv`. You can also use the `get_recomended_whitelist.sh` Bash script to get the recommended whitelists.
### Running locally