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

updated remaining list terms

Browse Source
This commit is contained in:
Viet Huynh
2023-09-17 16:52:03 +07:00
parent 245cc2e8cf
commit 0828fd3352
4 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -3
View File
@@ -7,7 +7,7 @@ Cloudflare Gateway allows you to create custom rules to filter HTTP, DNS, and ne
## About the individual scripts
- `cf_list_delete.js` - Deletes all lists created by CGPS from Cloudflare Gateway. This is useful for subsequent runs.
- `cf_list_create.js` - Takes an input.csv file containing domains and creates lists in Cloudflare Gateway
- `cf_list_create.js` - Takes an blocklist.txt file containing domains and creates lists in Cloudflare Gateway
- `cf_gateway_rule_create.js` - Creates a Cloudflare Gateway rule to block all traffic if it matches the lists created by CGPS.
- `cf_gateway_rule_delete.js` - Deletes the Cloudflare Gateway rule created by CGPS. Useful for subsequent runs.
@@ -27,8 +27,8 @@ Cloudflare Gateway allows you to create custom rules to filter HTTP, DNS, and ne
1. Node.js installed on your machine
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 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.
4. A file containing the domains you want to block - **max 300,000 domains for the free plan** - in the working directory named `blocklist.txt`. 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 whitelist domains by putting them in a file `allowlist.txt`. You can also use the `get_recomended_whitelist.sh` Bash script to get the recommended whitelists.
### Running locally
download_files.js → download_lists.js
View File
get_recommended_filters.sh
+2 -2
View File
@@ -10,8 +10,8 @@ urls=(
https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts
)
# download all files in parallel and append them to input.csv
node download_files.js blocklist.txt ${urls[@]}
# download all files in parallel and append them to blocklist.txt
node download_lists.js blocklist.txt ${urls[@]}
# print a message when done
echo "Done. The blocklist.txt file contains merged data from recommended filter lists."
get_recommended_whitelist.sh
+2 -2
View File
@@ -33,8 +33,8 @@ urls=(
)
# download all files in parallel and append them to whitelist.csv
node download_files.js allowlist.txt ${urls[@]}
# download all files in parallel and append them to allowlist.txt
node download_lists.js allowlist.txt ${urls[@]}
# print a message when done
echo "Done. The allowlist.txt file contains merged data from recommended whitelists."