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

docs: update README formatting

Browse Source
This commit is contained in:
Rekryt
2024-08-30 15:33:22 +03:00
parent 171e449744
commit 8c11dca0a9
2 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.en.md
View File

@@ -1,9 +1,10 @@
# IP Address Collection and Management Service # 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).
![iplist](https://github.com/user-attachments/assets/2e363fd8-1df7-4554-bf9e-98f58c13df96)
Demo URL: [https://iplist.opencck.org](https://iplist.opencck.org) Demo URL: [https://iplist.opencck.org](https://iplist.opencck.org)
![iplist](https://github.com/user-attachments/assets/2e363fd8-1df7-4554-bf9e-98f58c13df96)
## 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.
@@ -145,7 +146,7 @@ php index.php
:delay 10s :delay 10s
:log info "New iplist_youtube_v4_cidr added successfully"; :log info "New iplist_youtube_v4_cidr added successfully";
``` ```
![1](https://github.com/user-attachments/assets/5c88ea7a-7d5b-41de-8405-e1d2b13b96a2) - ![1](https://github.com/user-attachments/assets/5c88ea7a-7d5b-41de-8405-e1d2b13b96a2)
- Save the script - Save the script
- Go to System -> Scheduler - Go to System -> Scheduler
- Create a new task with a name of your choice, for example `iplist_youtube_v4_cidr` - Create a new task with a name of your choice, for example `iplist_youtube_v4_cidr`
@@ -154,12 +155,12 @@ php index.php
``` ```
iplist_youtube_v4_cidr iplist_youtube_v4_cidr
``` ```
![2](https://github.com/user-attachments/assets/1b364ddc-a4b7-4563-987c-3dd382eb082d) - ![2](https://github.com/user-attachments/assets/1b364ddc-a4b7-4563-987c-3dd382eb082d)
- Open the script in System -> Scripts and run it by clicking the `Run Script` button - Open the script in System -> Scripts and run it by clicking the `Run Script` button
- In the Logs section, you should see the message `New iplist_youtube_v4_cidr added successfully` - In the Logs section, you should see the message `New iplist_youtube_v4_cidr added successfully`
![3](https://github.com/user-attachments/assets/4ef15415-60f5-4c70-9f18-c8bece797e3d) - ![3](https://github.com/user-attachments/assets/4ef15415-60f5-4c70-9f18-c8bece797e3d)
- In IP -> Firewall -> Address Lists, a new list should appear (in this example, named `youtube.com`) - In IP -> Firewall -> Address Lists, a new list should appear (in this example, named `youtube.com`)
![4](https://github.com/user-attachments/assets/72d00414-252c-4ddb-84ed-80b09e247e39) - ![4](https://github.com/user-attachments/assets/72d00414-252c-4ddb-84ed-80b09e247e39)
### License ### License
The MIT License (MIT). Please see [LICENSE](./LICENSE) for more information. The MIT License (MIT). Please see [LICENSE](./LICENSE) for more information.

12
README.md
View File

@@ -1,10 +1,10 @@
### IP Address Collection and Management Service for Mikrotik RouterOS Script, JSON or Text Format ### IP Address Collection and Management Service for Mikrotik RouterOS Script, JSON or Text Format
For english readme: [README.en.md](README.en.md) For english readme: [README.en.md](README.en.md)
![iplist](https://github.com/user-attachments/assets/2e363fd8-1df7-4554-bf9e-98f58c13df96)
Demo URL: [https://iplist.opencck.org](https://iplist.opencck.org) Demo URL: [https://iplist.opencck.org](https://iplist.opencck.org)
![iplist](https://github.com/user-attachments/assets/2e363fd8-1df7-4554-bf9e-98f58c13df96)
# Сервис сбора IP-адресов и CIDR зон # Сервис сбора IP-адресов и CIDR зон
Данный сервис предназначен для сбора и обновления IP-адресов (IPv4 и IPv6), а также их CIDR зон для указанных доменов. Данный сервис предназначен для сбора и обновления IP-адресов (IPv4 и IPv6), а также их CIDR зон для указанных доменов.
Это асинхронный PHP веб-сервер на основе [AMPHP](https://amphp.org/) и с Linux-утилит `whois` и `ipcalc`. Это асинхронный PHP веб-сервер на основе [AMPHP](https://amphp.org/) и с Linux-утилит `whois` и `ipcalc`.
@@ -154,7 +154,7 @@ php index.php
:delay 10s :delay 10s
:log info "New iplist_youtube_v4_cidr added successfully"; :log info "New iplist_youtube_v4_cidr added successfully";
``` ```
![1](https://github.com/user-attachments/assets/5c88ea7a-7d5b-41de-8405-e1d2b13b96a2) - ![1](https://github.com/user-attachments/assets/5c88ea7a-7d5b-41de-8405-e1d2b13b96a2)
- Сохраните скрипт - Сохраните скрипт
- Откройте раздел планировщика System -> Scheduler - Откройте раздел планировщика System -> Scheduler
- Создайте новое задание с произвольным именем, например `iplist_youtube_v4_cidr` - Создайте новое задание с произвольным именем, например `iplist_youtube_v4_cidr`
@@ -163,12 +163,12 @@ php index.php
``` ```
iplist_youtube_v4_cidr iplist_youtube_v4_cidr
``` ```
![2](https://github.com/user-attachments/assets/1b364ddc-a4b7-4563-987c-3dd382eb082d) - ![2](https://github.com/user-attachments/assets/1b364ddc-a4b7-4563-987c-3dd382eb082d)
- Откройте скрипт в разделе System -> Scripts и запустите его нажатием на кнопку `Run Script` - Откройте скрипт в разделе System -> Scripts и запустите его нажатием на кнопку `Run Script`
- В разделе Logs вы должны увидеть сообщение `New iplist_youtube_v4_cidr added successfully` - В разделе Logs вы должны увидеть сообщение `New iplist_youtube_v4_cidr added successfully`
![3](https://github.com/user-attachments/assets/4ef15415-60f5-4c70-9f18-c8bece797e3d) - ![3](https://github.com/user-attachments/assets/4ef15415-60f5-4c70-9f18-c8bece797e3d)
- А в разделе IP -> Firewall -> Address Lists должен появиться новый список (в примере с именем `youtube.com`) - А в разделе IP -> Firewall -> Address Lists должен появиться новый список (в примере с именем `youtube.com`)
![4](https://github.com/user-attachments/assets/72d00414-252c-4ddb-84ed-80b09e247e39) - ![4](https://github.com/user-attachments/assets/72d00414-252c-4ddb-84ed-80b09e247e39)
### License ### License
The MIT License (MIT). Please see [LICENSE](./LICENSE) for more information. The MIT License (MIT). Please see [LICENSE](./LICENSE) for more information.