Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
maksimkurb committed Nov 11, 2024
1 parent a561f69 commit 256b11d
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 11 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
PKG_VERSION:=1.0.0
PKG_RELEASE:=5
PKG_RELEASE:=6
PKG_FULLVERSION:=$(PKG_VERSION)-$(PKG_RELEASE)

BINARY_NAME=keenetic-pbr
Expand Down
18 changes: 13 additions & 5 deletions README.en.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# 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)
![release](https://img.shields.io/github/v/release/maksimkurb/keenetic-pbr?sort=date)

#### [> README на русском <](./README.md)

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.
Expand Down Expand Up @@ -95,14 +97,20 @@ summarize = true
# Lists to be imported to ipset/dnsmasq
[[ipset.list]]
# List 1 name
name = "local"
# List of hosts
hosts = ["ifconfig.co", "myip2.ru", "1.2.3.4", "141.201.11.0/24"]

[[ipset.list]]
# List 2 name
name = "list-name"
# List 1 URL
# List 2 URL (file should contain domains, IPs and CIDRs, one per line)
url = "https://some-url/list1.lst"

[[ipset.list]]
# List 2 name
# List 3 name
name = "re-filter-ipsum"
# List 2 URL
# List 3 URL (file should contain domains, IPs and CIDRs, one per line)
url = "https://some-url/list2.lst"

# You can add as many ipsets as you want:
Expand Down
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# 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)
![release](https://img.shields.io/github/v/release/maksimkurb/keenetic-pbr?sort=date)

#### [> README in English <](./README.en.md)

Keenetic PBR — это утилита для маршрутизации на основе политики для маршрутизаторов Keenetic, позволяющая направлять трафик в соответствии с
определенными маршрутными политиками на основе списков доменов и IP-адресов.
Expand Down Expand Up @@ -91,18 +93,24 @@ summarize = true

# Приоритет для ip rule
priority = 1001

# Списки для импорта в ipset/dnsmasq
[[ipset.list]]
# Имя списка 1
name = "local"
# Список хостов списка 1
hosts = ["ifconfig.co", "myip2.ru", "1.2.3.4", "141.201.11.0/24"]

[[ipset.list]]
# Имя списка 2
name = "list-name"
# URL списка 1
# URL списка 2 (файл должен содержать домены, IP адреса и CIDR, по одному на каждой строчке)
url = "https://some-url/list1.lst"

[[ipset.list]]
# Имя списка 2
# Имя списка 3
name = "re-filter-ipsum"
# URL списка 2
# URL списка 3 (файл должен содержать домены, IP адреса и CIDR, по одному на каждой строчке)
url = "https://some-url/list2.lst"

# Вы можете добавлять столько ipset, сколько хотите:
Expand Down

0 comments on commit 256b11d

Please sign in to comment.