From 0828fd3352738c071e92c8365576f79395d36eb8 Mon Sep 17 00:00:00 2001 From: Viet Huynh Date: Sun, 17 Sep 2023 16:52:03 +0700 Subject: [PATCH] updated remaining list terms --- README.md | 6 +++--- download_files.js => download_lists.js | 0 get_recommended_filters.sh | 4 ++-- get_recommended_whitelist.sh | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) rename download_files.js => download_lists.js (100%) diff --git a/README.md b/README.md index c323eb8..1e1cdc1 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/download_files.js b/download_lists.js similarity index 100% rename from download_files.js rename to download_lists.js diff --git a/get_recommended_filters.sh b/get_recommended_filters.sh index e030f48..6d64cf8 100644 --- a/get_recommended_filters.sh +++ b/get_recommended_filters.sh @@ -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." diff --git a/get_recommended_whitelist.sh b/get_recommended_whitelist.sh index e1e2cc2..f8636b4 100644 --- a/get_recommended_whitelist.sh +++ b/get_recommended_whitelist.sh @@ -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."