Skip to content
Documentation
Getting Started
Installation

Installation

Keenetic

keen-pbr can be installed on Keenetic routers via the Entware opkg package manager.

First, ensure Entware is installed on your router. Then add the keen-pbr feed and install the package:

opkg update
opkg install keen-pbr

The package installs its config at /opt/etc/keen-pbr/config.json and enables the init script automatically.

Start the service:

/opt/etc/init.d/S80keen-pbr start

Restart it after editing the config:

/opt/etc/init.d/S80keen-pbr restart

OpenWRT

On OpenWRT, install via opkg:

opkg update
opkg install keen-pbr

After installation, the config file is at /etc/keen-pbr/config.json. Start the service:

service keen-pbr start

Enable autostart:

service keen-pbr enable

Post-Install

After installation, the default config path is /etc/keen-pbr/config.json on OpenWrt and /opt/etc/keen-pbr/config.json on Keenetic. See the Quick Start guide for a minimal working configuration, or the full Configuration reference.

If pre-built packages are not yet available for your platform, see Build from Source to compile keen-pbr yourself.

CLI Flags

Flag Description
--config <path> Path to the JSON config file (default depends on the build target, e.g. /etc/keen-pbr/config.json on OpenWrt and /opt/etc/keen-pbr/config.json on Keenetic)
-d Run as daemon (daemonize)
--no-api Disable the HTTP API even if configured
--version Print version and exit
--help Print help and exit

Signals

Signal Action
SIGUSR1 Re-verify routing tables and trigger immediate URL tests
SIGHUP Full reload: re-download lists, re-apply firewall and routing rules
SIGTERM / SIGINT Graceful shutdown

Example full reload via signal:

kill -HUP $(cat /var/run/keen-pbr.pid)
Quick Start