diff --git a/README.en.md b/README.en.md index 4c3c6a7..bb06059 100644 --- a/README.en.md +++ b/README.en.md @@ -116,6 +116,22 @@ http://0.0.0.0:8080/?format=mikrotik&site=youtube.com&data=cidr4 http://0.0.0.0:8080/?format=comma&data=cidr4 ``` +| GET Parameter | Description | Example | +|-----------------|----------------------------|-----------------------------------------------| +| format | Data export format | ?format=text | +| data | Data for export | ?data=cidr4 | +| site | Portal for data export | ?site=youtube.com | +| group | Group for data export | ?group=youtube | +| exclude[ip4] | Exclude IPv4 addresses | ?exclude[ip4]=1.1.1.1&exclude[ip4]=2.2.2.2 | +| exclude[ip6] | Exclude IPv6 addresses | ?exclude[ip6]=2a06:98c1:3121::a | +| exclude[cidr4] | Exclude CIDRv4 zones | ?exclude[cidr4]=1.1.1.0/24 | +| exclude[cidr6] | Exclude CIDRv6 zones | ?exclude[cidr6]=2a06:98c1::/32 | +| exclude[group] | Exclude groups | ?exclude[group]=youtube&exclude[group]=casino | +| exclude[site] | Exclude portals | ?exclude[site]=youtube.com | +| exclude[domain] | Exclude domains | ?exclude[domain]=youtube.com | +| wildcard | Keep only wildcard domains | ?wildcard=1 | +| filesave | Save as a file | ?filesave=1 | + ## SSL Setup - Install and configure a reverse proxy, for example, [NginxProxyManager](https://nginxproxymanager.com/guide/#quick-setup). - Create a Docker virtual network: diff --git a/README.md b/README.md index 61b203b..36a1ee8 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,22 @@ http://0.0.0.0:8080/?format=mikrotik&site=youtube.com&data=cidr4 http://0.0.0.0:8080/?format=comma&data=cidr4 ``` +| get параметр | описание | пример | +|------------------|----------------------------------|-----------------------------------------------| +| format | Формат выгрузки данных | ?format=text | +| data | Данные для выгрузки | ?data=cidr4 | +| site | Портал для выгрузки данных | ?site=youtube.com | +| group | Группа для выгрузки данных | ?group=youtube | +| exclude[ip4] | Исключить ipv4 адреса | ?exclude[ip4]=1.1.1.1&exclude[ip4]=2.2.2.2 | +| exclude[ip6] | Исключить ipv6 адреса | ?exclude[ip6]=2a06:98c1:3121::a | +| exclude[cidr4] | Исключить CIDRv4 зоны | ?exclude[cidr4]=1.1.1.0/24 | +| exclude[cidr6] | Исключить CIDRv6 зоны | ?exclude[cidr6]=2a06:98c1::/32 | +| exclude[group] | Исключить группы | ?exclude[group]=youtube&exclude[group]=casino | +| exclude[site] | Исключить порталы | ?exclude[site]=youtube.com | +| exclude[domain] | Исключить домены | ?exclude[domain]=youtube.com | +| wildcard | Оставлять только wildcard домены | ?wildcard=1 | +| filesave | Сохранять как файл | ?filesave=1 | + ## Настройка SSL Для настройки SSL сертификата вам понадобится домен настроенный на ваш сервер. Если у вас нет собственного домена - как вариант бесплатный домен можно получить например на [https://noip.com](https://noip.com).