anpleenko/iplist
1
0
Fork 0
mirror of https://github.com/rekryt/iplist.git synced 2025-10-12 16:39:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: documentation updates

Browse Source
This commit is contained in:
Rekryt
2024-08-31 15:36:44 +03:00
parent fe752cede2
commit 1e4afdfe33
2 changed files with 15 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.en.md
View File

@@ -8,7 +8,7 @@ Demo URL: [https://iplist.opencck.org](https://iplist.opencck.org)
## Key Features ## Key Features
- **Domain Monitoring**: Collect and update IP addresses and CIDR zones for specified domains. - **Domain Monitoring**: Collect and update IP addresses and CIDR zones for specified domains.
- **Multi-Format Output**: Supports output in plain text, JSON format, and script format for RouterOS Mikrotik. - **Multi-Format Output**: Supports output in plain text, JSON format, script format for RouterOS Mikrotik, or comma separated values.
- **Integration with External Data Sources**: Supports importing initial data from external URLs. - **Integration with External Data Sources**: Supports importing initial data from external URLs.
- **Easy Deployment with Docker Compose**. - **Easy Deployment with Docker Compose**.
- **Configuration through JSON files for managing domains and IPs**. - **Configuration through JSON files for managing domains and IPs**.
@@ -81,7 +81,8 @@ If needed, edit the `.env` file:
|-----------------------|---------------|----------------------------------------------------------------| |-----------------------|---------------|----------------------------------------------------------------|
| COMPOSE_PROJECT_NAME | iplist | Name of the compose project | | COMPOSE_PROJECT_NAME | iplist | Name of the compose project |
| STORAGE_SAVE_INTERVAL | 120 | Cache save interval for whois (seconds) | | STORAGE_SAVE_INTERVAL | 120 | Cache save interval for whois (seconds) |
| SYS_MEMORY_LIMIT | 512M | Memory limit. 1MB is sufficient for the initial configuration | | SYS_DNS_RESOLVE_DELAY | 1000 | Delay between receiving dns records (milliseconds) |
| SYS_MEMORY_LIMIT | 1024M | Memory limit |
| SYS_TIMEZONE | Europe/Moscow | List of URLs to obtain initial CIDRv4 zones for IPv4 addresses | | SYS_TIMEZONE | Europe/Moscow | List of URLs to obtain initial CIDRv4 zones for IPv4 addresses |
| DEBUG | true | Determines the logging level | | DEBUG | true | Determines the logging level |
@@ -93,6 +94,7 @@ http://0.0.0.0:8080/?format=json&site=youtube.com&data=domains
http://0.0.0.0:8080/?format=text&site=youtube.com&data=ip4 http://0.0.0.0:8080/?format=text&site=youtube.com&data=ip4
http://0.0.0.0:8080/?format=mikrotik&data=cidr4 http://0.0.0.0:8080/?format=mikrotik&data=cidr4
http://0.0.0.0:8080/?format=mikrotik&site=youtube.com&data=cidr4 http://0.0.0.0:8080/?format=mikrotik&site=youtube.com&data=cidr4
http://0.0.0.0:8080/?format=comma&data=cidr4
``` ```
## SSL Setup ## SSL Setup

20
README.md
View File

@@ -12,8 +12,8 @@ Demo URL: [https://iplist.opencck.org](https://iplist.opencck.org)
Основные возможности Основные возможности
- Мониторинг доменов: Сбор и обновление IP-адресов и CIDR зон для указанных доменов. - Мониторинг доменов: Сбор и обновление IP-адресов и CIDR зон для указанных доменов.
- Многоформатный вывод: Поддержка вывода данных в текстовом формате, формате JSON и в виде скрипта для RouterOS Mikrotik. - Поддержка вывода данных в текстовом формате, формате JSON, в виде скрипта для RouterOS Mikrotik или данные разделённые запятой.
- Интеграция с внешними источниками данных: поддержка импорта начальных данных из внешних URL. - Интеграция с внешними источниками данных (поддержка импорта начальных данных из внешних URL).
- Легкое развертывание с помощью Docker Compose. - Легкое развертывание с помощью Docker Compose.
- Настройка через JSON файлы для управления доменами и IP. - Настройка через JSON файлы для управления доменами и IP.
@@ -78,13 +78,14 @@ cp .env.example .env
Если требуется отредактируйте `.env` файл Если требуется отредактируйте `.env` файл
| свойство | значение по умолчанию | описание | | свойство | значение по умолчанию | описание |
|-----------------------|-----------------------|---------------------------------------------------------------------| |-----------------------|-----------------------|------------------------------------------------------------|
| COMPOSE_PROJECT_NAME | iplist | Имя compose проекта | | COMPOSE_PROJECT_NAME | iplist | Имя compose проекта |
| STORAGE_SAVE_INTERVAL | 120 | Период сохранения кеша whois (секунды) | | STORAGE_SAVE_INTERVAL | 120 | Период сохранения кеша whois (секунды) |
| SYS_MEMORY_LIMIT | 512M | Предельное кол-во памяти. Для начальной конфигурации достаточно 1МБ | | SYS_DNS_RESOLVE_DELAY | 1000 | Задержка между получением dns записей (миллисекунды) |
| SYS_TIMEZONE | Europe/Moscow | Список URL для получения начальных CIDRv4 зон ipv4 адресов | | SYS_MEMORY_LIMIT | 1024M | Предельное кол-во памяти. |
| DEBUG | true | Определяет уровень логирования | | SYS_TIMEZONE | Europe/Moscow | Список URL для получения начальных CIDRv4 зон ipv4 адресов |
| DEBUG | true | Определяет уровень логирования |
```shell ```shell
docker compose up -d docker compose up -d
@@ -98,6 +99,7 @@ http://0.0.0.0:8080/?format=json&site=youtube.com&data=domains
http://0.0.0.0:8080/?format=text&site=youtube.com&data=ip4 http://0.0.0.0:8080/?format=text&site=youtube.com&data=ip4
http://0.0.0.0:8080/?format=mikrotik&data=cidr4 http://0.0.0.0:8080/?format=mikrotik&data=cidr4
http://0.0.0.0:8080/?format=mikrotik&site=youtube.com&data=cidr4 http://0.0.0.0:8080/?format=mikrotik&site=youtube.com&data=cidr4
http://0.0.0.0:8080/?format=comma&data=cidr4
``` ```
## Настройка SSL ## Настройка SSL