Merge branch 'wip-python'

fixed yaml exemple in readme
2025-06-01 11:28:15 +00:00 · 2025-06-01 11:27:37 +00:00
1 changed files with 8 additions and 9 deletions
--- a/README.md
+++ b/README.md
@@ -20,7 +20,7 @@
 ## Features

 - Downloads CIDR lists by country from GitHub  
- Adds manual IPs from a `manually_blocked_ips.conf` file  
+- (Optional) Adds manual IPs from a `manually_blocked_ips.conf` file  
 - Updates the `AdGuardHome.yaml` file by replacing the `disallowed_clients` list  
 - Creates a backup of the original config (`AdGuardHome.yaml.first-start.bak`) on first run  
 - Creates a backup before each update (`AdGuardHome.yaml.last-update.bak`)  
@@ -47,11 +47,10 @@

 ## File Structure

- `update-blocklist.sh`: Main script to download CIDRs, merge manual IPs, update config, and restart AdGuard.
- `entrypoint.sh`: Sets up the cron job to periodically run the update script.
- `Dockerfile`: Builds the lightweight Alpine-based image.
+- `blocklist_scheduler.py`: Script to backup, schedule, download CIDRs, merge manual IPs, update config, and restart AdGuard.
+- `Dockerfile`: Builds the lightweight python3-slim image.
 - `docker-compose.yml`: Example compose file to run the container.
- `manually_blocked_ips.conf`: (Volume mount) Add extra IPs to block manually.
+- (optional) `manually_blocked_ips.conf`:  Add extra IPs to block manually.

 ## Installation and Usage

@@ -96,7 +95,7 @@
 2. **Modify docker-compose.yml**

 - Set `BLOCK_COUNTRIES` environment variable with the countries you want to block.
- Adjust `BLOCKLIST_CRON` if you want a different update frequency.
+- Adjust `BLOCKLIST_CRON` variables if you want a different update frequency.
 - Bind mount your adguard configuration folder (wich contains `AdGuardHome.yaml`) to `/adguard`
 - (optionnally) create and edit `manually_blocked_ips.conf` file in your adguard configuration folder to add other IPs you want to block. Only valid IP or CIDR entries will be processed, for exemple :

@@ -127,7 +126,7 @@
 2. **Modify docker-compose.yml**

 - Set `BLOCK_COUNTRIES` environment variable with the countries you want to block.
- Adjust `BLOCKLIST_CRON` if you want a different update frequency.
+- Adjust `BLOCKLIST_CRON` variables if you want a different update frequency.
 - Bind mount your adguard configuration folder (wich contains `AdGuardHome.yaml`) to `/adguard`
 - (optionnally) create and edit `manually_blocked_ips.conf` file in your adguard configuration folder to add other IPs you want to block. Only valid IP or CIDR entries will be processed, for exemple :
Author	SHA1	Message	Date
Djeex	2340aea618	Merge branch 'wip-python'	2025-06-01 11:28:15 +00:00
Djeex	5f54c87cf2	fixed yaml exemple in readme	2025-06-01 11:27:37 +00:00