From 06d1d128cad523e54ec56c2c36b7d5dec92855c9 Mon Sep 17 00:00:00 2001 From: Rekryt Date: Wed, 16 Oct 2024 09:51:38 +0300 Subject: [PATCH] docs: updates in README files --- README.en.md | 20 +++++++++++--------- README.md | 20 +++++++++++--------- 2 files changed, 22 insertions(+), 18 deletions(-) diff --git a/README.en.md b/README.en.md index 7bddd63..6dc166a 100644 --- a/README.en.md +++ b/README.en.md @@ -1,5 +1,5 @@ # IP Address Collection and Management Service -This service is designed for collecting and updating IP addresses (IPv4 and IPv6) and their CIDR zones for specified domains. It is implemented as a web server using asynchronous PHP 8.1+ with the AMPHP library and integrates with Linux utilities like `whois` and `ipcalc`. The service provides interfaces for retrieving lists of domains, IPv4 addresses, IPv6 addresses, as well as CIDRv4 and CIDRv6 zones in various formats, including plain text, JSON, and scripts for adding to "Address List" on Mikrotik routers (RouterOS). +This service is designed for collecting and updating IP addresses (IPv4 and IPv6) and their CIDR zones for specified domains. It is implemented as a web server using asynchronous PHP 8.1+ with the AMPHP library and integrates with Linux utilities like `whois` and `ipcalc`. The service provides interfaces for retrieving lists of domains, IPv4 addresses, IPv6 addresses, as well as CIDRv4 and CIDRv6 zones in various formats, including plain text, JSON, and scripts for adding to "Address List" on Mikrotik routers (RouterOS), Keenetic KVAS\BAT, SwitchyOmega, Amnezia and more. Demo URL: [https://iplist.opencck.org](https://iplist.opencck.org) @@ -75,13 +75,13 @@ Configuration files are stored in the `config//.json`. Each JSON fi | cidr6 | string[] | Initial list of CIDRv6 zones of IPv6 addresses | | external | object | Lists of URLs to retrieve initial data from external sources | -| property | type | description | -|----------|----------|-----------------------------------------------------------------| -| domains | string[] | List of URLs to retrieve portal domains | -| ip4 | string[] | List of URLs to retrieve initial IPv4 addresses | -| ip6 | string[] | List of URLs to retrieve initial IPv6 addresses | -| cidr4 | string[] | List of URLs to retrieve initial CIDRv4 zones of IPv4 addresses | -| cidr6 | string[] | List of URLs to retrieve initial CIDRv6 zones of IPv6 addresses | +| property | type | description | +|----------|----------|--------------------------------------------------------------| +| domains | string[] | List of URLs for replenishing portal domains | +| ip4 | string[] | List of URLs for replenishing ipv4 addresses | +| ip6 | string[] | List of URLs for replenishing IPv6 addresses | +| cidr4 | string[] | List of URLs for replenishing CIDRv4 zones of IPv4 addresses | +| cidr6 | string[] | List of URLs for replenishing CIDRv6 zones of IPv6 addresses | ## Setting Up and Running in Docker ```shell @@ -199,11 +199,13 @@ chmod +x /etc/homeproxy/scripts/update_resources.sh Open the administrative panel in OpenWRT, go to the "System" - "Startup" - "Local Startup" section. Add the following lines before "exit 0" to automatically run the update script at startup, as well as at 00:05:00 and 12:05:00 ```shell +sleep 15 + /etc/homeproxy/scripts/update_crond.sh echo "5 0,12 * * * /etc/homeproxy/scripts/update_crond.sh" > /etc/crontabs/root -/etc/init.d/cron start /etc/init.d/cron enable +/etc/init.d/cron start ``` ![2](https://github.com/user-attachments/assets/2369b32c-d43a-4837-97ce-c46a9dd79e5e) diff --git a/README.md b/README.md index e2ffb7a..5274c32 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Demo URL: [https://iplist.opencck.org](https://iplist.opencck.org) # Сервис сбора IP-адресов и CIDR зон Данный сервис предназначен для сбора и обновления IP-адресов (IPv4 и IPv6), а также их CIDR зон для указанных доменов. Это асинхронный PHP веб-сервер на основе [AMPHP](https://amphp.org/) и Linux-утилит `whois` и `ipcalc`. -Сервис предоставляет интерфейсы для получения списков зон ip адресов указанных доменов (IPv4 адресов, IPv6 адресов, а также CIDRv4 и CIDRv6 зон) в различных форматах, включая текстовый, JSON и формате скрипта для добавления в "Address List" на роутерах Mikrotik (RouterOS). +Сервис предоставляет интерфейсы для получения списков зон ip адресов указанных доменов (IPv4 адресов, IPv6 адресов, а также CIDRv4 и CIDRv6 зон) в различных форматах, включая текстовый, JSON, форматы скриптов для добавления в "Address List" на роутерах Mikrotik (RouterOS), Keenetic KVAS\BAT, SwitchyOmega, Amnezia и др. Основные возможности - Мониторинг доменов: Сбор и обновление IP-адресов и CIDR зон для указанных доменов. @@ -76,13 +76,13 @@ Demo URL: [https://iplist.opencck.org](https://iplist.opencck.org) | cidr6 | string[] | Начальный список CIDRv6 зон ipv6 адресов | | external | object | Списки URL для получения начальных данных от сторонних источников | -| свойство | тип | описание | -|----------|----------|------------------------------------------------------------| -| domains | string[] | Список URL для получения доменов портала | -| ip4 | string[] | Список URL для получения начальных ipv4 адресов | -| ip6 | string[] | Список URL для получения начальных ipv6 адресов | -| cidr4 | string[] | Список URL для получения начальных CIDRv4 зон ipv4 адресов | -| cidr6 | string[] | Список URL для получения начальных CIDRv6 зон ipv6 адресов | +| свойство | тип | описание | +|----------|----------|-----------------------------------------------------| +| domains | string[] | Список URL для пополнения доменов портала | +| ip4 | string[] | Список URL для пополнения ipv4 адресов | +| ip6 | string[] | Список URL для пополнения ipv6 адресов | +| cidr4 | string[] | Список URL для пополнения CIDRv4 зон ipv4 адресов | +| cidr6 | string[] | Список URL для пополнения CIDRv6 зон ipv6 адресов | ## Настройка и запуск под docker ```shell @@ -207,11 +207,13 @@ chmod +x /etc/homeproxy/scripts/update_resources.sh Откройте административную панель OpenWRT раздел "System" - "Startup" - "Local Startup". Добавьте перед "exit 0" строки, чтобы автоматически запускать скрипт обновления при старте, а также в 00:05:00 и 12:05:00 ```shell +sleep 15 + /etc/homeproxy/scripts/update_crond.sh echo "5 0,12 * * * /etc/homeproxy/scripts/update_crond.sh" > /etc/crontabs/root -/etc/init.d/cron start /etc/init.d/cron enable +/etc/init.d/cron start ``` ![2](https://github.com/user-attachments/assets/2369b32c-d43a-4837-97ce-c46a9dd79e5e)