Add ability to provide local lists

Makefile

@@ -1,5 +1,5 @@
 PKG_VERSION:=1.0.0
-PKG_RELEASE:=4
+PKG_RELEASE:=5
 PKG_FULLVERSION:=$(PKG_VERSION)-$(PKG_RELEASE)
 
 BINARY_NAME=keenetic-pbr

README.en.md

@@ -0,0 +1,177 @@
+# Keenetic PBR
+
+![workflow status](https://img.shields.io/github/actions/workflow/status/maksimkurb/keenetic-pbr/.github%2Fworkflows%2Fbuild-ci.yml?branch=main)
+![release](https://img.shields.io/github/v/release/maksimkurb/keenetic-pbr)
+
+Keenetic PBR is a utility for policy-based routing on Keenetic routers, enabling you to direct traffic according to
+specific routing policies based on domain lists and IP sets.
+
+It is configurable to integrate with `dnsmasq` for
+domain-based routing and utilizes `ipset` for routing control.
+
+## Features
+
+- Domain-based routing via `dnsmasq`
+- IP-based routing via `ipset`
+- Customizable routing tables and priorities
+- Automatic configuration for `dnsmasq` lists
+
+## Installation (one-liner)
+
+Connect to your EntWare using SSH and run the following command:
+
+   ```bash
+   opkg install curl jq && curl -sOfL https://raw.githubusercontent.com/maksimkurb/keenetic-pbr/refs/heads/main/install.sh && sh install
+   ```
+
+## Installation (manual)
+
+1. Go to [releases](https://github.com/maksimkurb/keenetic-pbr/releases) page and copy URL for the latest `.ipk` file
+   for your architecture
+
+2. Download the `.ipk` file on your router:
+   ```bash
+   curl -LO <URL-to-latest-ipk-file-for-your-architecture>
+   ```
+
+2. **Install it using OPKG:**
+
+   ```bash
+   opkg install keenetic-pbr-*-entware.ipk
+   ```
+
+This will install Keenetic PBR and configure it on your router.
+
+## Configuration
+
+The installer replaces original **dnsmasq** configuration file.
+A backup of your original file is saved as `/opt/etc/dnsmasq.conf.orig`.
+
+Adjust the configuration in the following files according to your needs:
+
+- **Keenetic-PBR configuration:** `/opt/etc/keenetic-pbr/keenetic-pbr.conf`
+- **dnsmasq configuration:** `/opt/etc/dnsmasq.conf`
+
+### 1. Edit `keenetic-pbr.conf`
+
+Open `/opt/etc/keenetic-pbr/keenetic-pbr.conf` and edit as needed.
+
+The main thing you probably want to edit is to change `interface` for routing.
+
+```ini
+[general]
+# Path to `ipset` binary
+ipset_path = "ipset"
+
+# Output directory for routing lists
+lists_output_dir = "/opt/etc/keenetic-pbr/lists.d"
+
+# Downloaded lists would be saved to this directory for dnsmasq
+dnsmasq_lists_dir = "/opt/etc/dnsmasq.d"
+
+# If true, keenetic-pbr would summarize IPs and CIDRs before applying them to ipset
+summarize = true
+
+[[ipset]]
+   # Name of the ipset
+   ipset_name = "vpn"
+
+   # Clear ipset each time before loading it
+   flush_before_applying = true
+
+  [ipset.routing]
+  # Target interface for routing
+  interface = "nwg1"
+
+  # This fwmark would apply to all packets with IPs from this ipset
+  fwmark = 1001
+
+  # ip routing table number
+  table = 1001
+
+  # ip rule priority number
+  priority = 1001
+
+  # Lists to be imported to ipset/dnsmasq
+  [[ipset.list]]
+  # List 1 name
+  name = "list-name"
+  # List 1 URL
+  url = "https://some-url/list1.lst"
+
+  [[ipset.list]]
+  # List 2 name
+  name = "re-filter-ipsum"
+  # List 2 URL
+  url = "https://some-url/list2.lst"
+
+# You can add as many ipsets as you want:
+
+# [[ipset]]
+#   ipset_name = "direct"
+#   flush_before_applying = true
+#
+#   [ipset.routing]
+#   interface = "ppp0"
+#   fwmark = 998
+#   table = 998
+#   priority = 998
+#   
+#   [[ipset.list]]
+#   name = "list-name"
+#   url = "https://some-url/list1.lst"
+#
+#   [[ipset.list]]
+#   name = "re-filter-ipsum"
+#   url = "https://some-url/list2.lst"
+#
+# [[ipset]]
+#   ...
+#
+#   [ipset.routing]
+#   ...
+#  
+#   [[ipset.list]]
+#   ...
+```
+
+### 2. Download lists
+
+After editing the configuration file, download list files
+
+```bash
+keenetic-pbr download
+```
+
+### 3. Enable DNS-override
+
+1. Open the following URL in the browser:
+   ```
+   http://<router-ip-address>/a
+   ```
+2. Enter the following commands:
+   1. `opkg dns-override`
+   2. `system configuration save`
+
+### 4. Restart OPKG and verify if routing works
+
+Restart OPKG and ensure policy-based routing is functioning as expected.
+
+## Updating lists
+List are updated daily by cron automatically.
+
+You can update lists manually by running the following commands
+```
+keenetic-pbr download
+/opt/etc/init.d/S80keenetic-pbr restart
+```
+
+## Troubleshooting
+
+For any issues, verify your configuration files and logs.
+Ensure lists are downloaded correctly, and `dnsmasq` is running with the updated configuration.
+
+
+---
+
+Enjoy seamless policy-based routing with Keenetic-PBR!

README.md

@@ -0,0 +1,177 @@
+# Keenetic PBR
+
+![workflow status](https://img.shields.io/github/actions/workflow/status/maksimkurb/keenetic-pbr/.github%2Fworkflows%2Fbuild-ci.yml?branch=main)
+![release](https://img.shields.io/github/v/release/maksimkurb/keenetic-pbr)
+
+Keenetic PBR — это утилита для маршрутизации на основе политики для маршрутизаторов Keenetic, позволяющая направлять трафик в соответствии с
+определенными маршрутными политиками на основе списков доменов и IP-адресов.
+
+Она настраивается для интеграции с `dnsmasq` для
+маршрутизации на основе доменов и использует `ipset` для контроля маршрутизации.
+
+## Особенности
+
+- Маршрутизация на основе доменов через `dnsmasq`
+- Маршрутизация на основе IP-адресов через `ipset`
+- Настраиваемые таблицы маршрутизации и приоритеты
+- Автоматическая настройка для списков `dnsmasq`
+
+## Установка (однострочная команда)
+
+Подключитесь к вашему EntWare через SSH и выполните следующую команду:
+
+```bash
+opkg install curl jq && curl -sOfL https://raw.githubusercontent.com/maksimkurb/keenetic-pbr/refs/heads/main/install.sh && sh install
+```
+
+## Установка (ручной метод)
+
+1. Перейдите на страницу [релизов](https://github.com/maksimkurb/keenetic-pbr/releases) и скопируйте URL для последнего `.ipk` файла
+   для вашей архитектуры
+
+2. Скачайте `.ipk` файл на ваш маршрутизатор:
+   ```bash
+   curl -LO <URL-to-latest-ipk-file-for-your-architecture>
+   ```
+
+3. **Установите его с помощью OPKG:**
+
+   ```bash
+   opkg install keenetic-pbr-*-entware.ipk
+   ```
+
+Это установит Keenetic PBR и настроит его на вашем маршрутизаторе.
+
+## Настройка
+
+Установщик заменяет оригинальный файл конфигурации **dnsmasq**.
+Резервная копия вашего оригинального файла сохраняется как `/opt/etc/dnsmasq.conf.orig`.
+
+Отредактируйте конфигурацию в следующих файлах в соответствии с вашими потребностями:
+
+- **Конфигурация Keenetic-PBR:** `/opt/etc/keenetic-pbr/keenetic-pbr.conf`
+- **Конфигурация dnsmasq:** `/opt/etc/dnsmasq.conf`
+
+### 1. Редактирование `keenetic-pbr.conf`
+
+Откройте `/opt/etc/keenetic-pbr/keenetic-pbr.conf` и отредактируйте его по мере необходимости.
+
+Основное, что вы, вероятно, захотите изменить — это `interface` для маршрутизации.
+
+```ini
+[general]
+# Путь к бинарному файлу `ipset`
+ipset_path = "ipset"
+
+# Выходной каталог для маршрутизационных списков
+lists_output_dir = "/opt/etc/keenetic-pbr/lists.d"
+
+# Загруженные списки будут сохранены в этом каталоге для dnsmasq
+dnsmasq_lists_dir = "/opt/etc/dnsmasq.d"
+
+# Если true, keenetic-pbr будет суммировать IP-адреса и CIDR перед применением к ipset
+summarize = true
+
+[[ipset]]
+   # Имя ipset
+   ipset_name = "vpn"
+
+   # Очищать ipset каждый раз перед его загрузкой
+   flush_before_applying = true
+
+   [ipset.routing]
+   # Целевой интерфейс для маршрутизации
+   interface = "nwg1"
+
+   # Этот fwmark будет применяться ко всем пакетам с IP-адресами из этого ipset
+   fwmark = 1001
+
+   # Номер таблицы маршрутизации для ip route
+   table = 1001
+
+   # Приоритет для ip rule
+   priority = 1001
+
+   # Списки для импорта в ipset/dnsmasq
+   [[ipset.list]]
+   # Имя списка 1
+   name = "list-name"
+   # URL списка 1
+   url = "https://some-url/list1.lst"
+
+   [[ipset.list]]
+   # Имя списка 2
+   name = "re-filter-ipsum"
+   # URL списка 2
+   url = "https://some-url/list2.lst"
+
+# Вы можете добавлять столько ipset, сколько хотите:
+
+# [[ipset]]
+#   ipset_name = "direct"
+#   flush_before_applying = true
+#
+#   [ipset.routing]
+#   interface = "ppp0"
+#   fwmark = 998
+#   table = 998
+#   priority = 998
+#   
+#   [[ipset.list]]
+#   name = "list-name"
+#   url = "https://some-url/list1.lst"
+#
+#   [[ipset.list]]
+#   name = "re-filter-ipsum"
+#   url = "https://some-url/list2.lst"
+#
+# [[ipset]]
+# ...
+#
+#   [ipset.routing]
+#   ...
+#  
+#   [[ipset.list]]
+#   ...
+```
+
+### 2. Скачивание списков
+
+После редактирования конфигурационного файла скачайте файлы списков
+
+```bash
+keenetic-pbr download
+```
+
+### 3. Включение DNS-override
+
+1. Откройте следующий URL в браузере:
+   ```
+   http://<router-ip-address>/a
+   ```
+2. Введите следующие команды:
+   1. `opkg dns-override`
+   2. `system configuration save`
+
+### 4. Перезапуск OPKG и проверка работы маршрутизации
+
+Перезапустите OPKG и убедитесь, что маршрутизация на основе политики работает должным образом.
+
+## Обновление списков
+Списки обновляются ежедневно автоматически с помощью cron.
+
+Вы можете обновить списки вручную, выполнив следующие команды:
+
+```bash
+keenetic-pbr download
+/opt/etc/init.d/S80keenetic-pbr restart
+```
+
+## Устранение неполадок
+
+Если возникают проблемы, проверьте ваши конфигурационные файлы и логи.
+Убедитесь, что списки были загружены правильно, и что `dnsmasq` работает с обновленной конфигурацией.
+
+---
+
+Приятного использования маршрутизации на основе политики с Keenetic-PBR!