docs: add about "template" parameter for custom output format

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

View File

@@ -117,7 +117,7 @@ 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 |
@@ -131,6 +131,7 @@ http://0.0.0.0:8080/?format=comma&data=cidr4
| exclude[domain] | Exclude domains | ?exclude[domain]=youtube.com |
| wildcard | Keep only wildcard domains | ?wildcard=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
- Install and configure a reverse proxy, for example, [NginxProxyManager](https://nginxproxymanager.com/guide/#quick-setup).

View File

@@ -123,7 +123,7 @@ http://0.0.0.0:8080/?format=comma&data=cidr4
```
| get параметр | описание | пример |
|------------------|----------------------------------|-----------------------------------------------|
|------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| format | Формат выгрузки данных | ?format=text |
| data | Данные для выгрузки | ?data=cidr4 |
| site | Портал для выгрузки данных | ?site=youtube.com |
@@ -137,6 +137,7 @@ http://0.0.0.0:8080/?format=comma&data=cidr4
| exclude[domain] | Исключить домены | ?exclude[domain]=youtube.com |
| wildcard | Оставлять только wildcard домены | ?wildcard=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 сертификата вам понадобится домен настроенный на ваш сервер.