From d82c0dfc37285bc8b4f634932f0e7db9b89c0db4 Mon Sep 17 00:00:00 2001 From: Viet Huynh Date: Sat, 9 Sep 2023 23:55:11 +0700 Subject: [PATCH] updated README for FAST_MODE --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 68e6f98..45569f0 100644 --- a/README.md +++ b/README.md @@ -56,8 +56,12 @@ Please note that the GitHub Action downloads the recommended blocklists and whit - `CLOUDFLARE_LIST_ITEM_LIMIT`: The maximum number of blocked domains allowed for your Cloudflare Zero Trust plan. Use 300000 for the free plan or if you're unsure. - `PING_URL`: /Optional/ The HTTP(S) URL to ping (using curl) after the GitHub Action has successfully updated your filters. Useful for monitoring. -3. Create a new file in the repository named `.github/workflows/main.yml` with the contents of `auto_update_github_action.yml` found in this repository. The default settings will update your filters every week at 3 AM UTC. You can change this by editing the `schedule` property. -4. Enable GitHub Actions in your repository settings. +3. Create the following GitHub Actions variables in your repository settings if you desire: + +- `FAST_MODE`: Enable the scripts to send the requests simultaneously. Beware that there's a rate limit of 1200 requests per five minutes (https://developers.cloudflare.com/fundamentals/api/reference/limits/) so make sure you know what you are doing. + +4. Create a new file in the repository named `.github/workflows/main.yml` with the contents of `auto_update_github_action.yml` found in this repository. The default settings will update your filters every week at 3 AM UTC. You can change this by editing the `schedule` property. +5. Enable GitHub Actions in your repository settings. ### DNS setup for Cloudflare Gateway