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: add about "template" parameter for custom output format

Browse Source
This commit is contained in:
Rekryt
2024-12-11 23:28:35 +03:00
parent 9f6b91ab7d
commit a1d7c277b6
2 changed files with 32 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.en.md
View File

@@ -116,21 +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 http://0.0.0.0:8080/?format=comma&data=cidr4
``` ```
| GET Parameter | Description | Example | | GET Parameter | Description | Example |
|-----------------|----------------------------|-----------------------------------------------| |-----------------|----------------------------|----------------------------------------------------------------------------------------------------------------|
| format | Data export format | ?format=text | | format | Data export format | ?format=text |
| data | Data for export | ?data=cidr4 | | data | Data for export | ?data=cidr4 |
| site | Portal for data export | ?site=youtube.com | | site | Portal for data export | ?site=youtube.com |
| group | Group for data export | ?group=youtube | | 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[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[ip6] | Exclude IPv6 addresses | ?exclude[ip6]=2a06:98c1:3121::a |
| exclude[cidr4] | Exclude CIDRv4 zones | ?exclude[cidr4]=1.1.1.0/24 | | exclude[cidr4] | Exclude CIDRv4 zones | ?exclude[cidr4]=1.1.1.0/24 |
| exclude[cidr6] | Exclude CIDRv6 zones | ?exclude[cidr6]=2a06:98c1::/32 | | exclude[cidr6] | Exclude CIDRv6 zones | ?exclude[cidr6]=2a06:98c1::/32 |
| exclude[group] | Exclude groups | ?exclude[group]=youtube&exclude[group]=casino | | exclude[group] | Exclude groups | ?exclude[group]=youtube&exclude[group]=casino |
| exclude[site] | Exclude portals | ?exclude[site]=youtube.com | | exclude[site] | Exclude portals | ?exclude[site]=youtube.com |
| exclude[domain] | Exclude domains | ?exclude[domain]=youtube.com | | exclude[domain] | Exclude domains | ?exclude[domain]=youtube.com |
| wildcard | Keep only wildcard domains | ?wildcard=1 | | wildcard | Keep only wildcard domains | ?wildcard=1 |
| filesave | Save as a file | ?filesave=1 | | filesave | Save as a file | ?filesave=1 |
| template | Custom output format | ?format=custom&template=[more](https://github.com/rekryt/iplist/blob/master/README.en.md#custom-output-format) |
## SSL Setup ## SSL Setup
- Install and configure a reverse proxy, for example, [NginxProxyManager](https://nginxproxymanager.com/guide/#quick-setup). - Install and configure a reverse proxy, for example, [NginxProxyManager](https://nginxproxymanager.com/guide/#quick-setup).

31
README.md
View File

@@ -122,21 +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 http://0.0.0.0:8080/?format=comma&data=cidr4
``` ```
| get параметр | описание | пример | | get параметр | описание | пример |
|------------------|----------------------------------|-----------------------------------------------| |------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| format | Формат выгрузки данных | ?format=text | | format | Формат выгрузки данных | ?format=text |
| data | Данные для выгрузки | ?data=cidr4 | | data | Данные для выгрузки | ?data=cidr4 |
| site | Портал для выгрузки данных | ?site=youtube.com | | site | Портал для выгрузки данных | ?site=youtube.com |
| group | Группа для выгрузки данных | ?group=youtube | | group | Группа для выгрузки данных | ?group=youtube |
| exclude[ip4] | Исключить ipv4 адреса | ?exclude[ip4]=1.1.1.1&exclude[ip4]=2.2.2.2 | | 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[ip6] | Исключить ipv6 адреса | ?exclude[ip6]=2a06:98c1:3121::a |
| exclude[cidr4] | Исключить CIDRv4 зоны | ?exclude[cidr4]=1.1.1.0/24 | | exclude[cidr4] | Исключить CIDRv4 зоны | ?exclude[cidr4]=1.1.1.0/24 |
| exclude[cidr6] | Исключить CIDRv6 зоны | ?exclude[cidr6]=2a06:98c1::/32 | | exclude[cidr6] | Исключить CIDRv6 зоны | ?exclude[cidr6]=2a06:98c1::/32 |
| exclude[group] | Исключить группы | ?exclude[group]=youtube&exclude[group]=casino | | exclude[group] | Исключить группы | ?exclude[group]=youtube&exclude[group]=casino |
| exclude[site] | Исключить порталы | ?exclude[site]=youtube.com | | exclude[site] | Исключить порталы | ?exclude[site]=youtube.com |
| exclude[domain] | Исключить домены | ?exclude[domain]=youtube.com | | exclude[domain] | Исключить домены | ?exclude[domain]=youtube.com |
| wildcard | Оставлять только wildcard домены | ?wildcard=1 | | wildcard | Оставлять только wildcard домены | ?wildcard=1 |
| filesave | Сохранять как файл | ?filesave=1 | | filesave | Сохранять как файл | ?filesave=1 |
| template | Шаблон выгрузки | ?format=custom&template=[подробнее](https://github.com/rekryt/iplist?tab=readme-ov-file#%D0%BA%D0%B0%D1%81%D1%82%D0%BE%D0%BC%D0%BD%D1%8B%D0%B9-%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%82-%D0%B2%D1%8B%D0%B2%D0%BE%D0%B4%D0%B0) |
## Настройка SSL ## Настройка SSL
Для настройки SSL сертификата вам понадобится домен настроенный на ваш сервер. Для настройки SSL сертификата вам понадобится домен настроенный на ваш сервер.