Skip to content
Documentation
Getting Started
Installation
OpenWrt

OpenWrt

keen-pbr can be installed on OpenWrt routers from the keen-pbr package repository.

Check which package manager your OpenWrt version uses

The repository page automatically shows the correct flow for your target:

  • OpenWrt 25.x and newer: apk
  • OpenWrt 24.x and older: opkg

Replace dnsmasq with dnsmasq-full

Install dnsmasq-full before installing keen-pbr:

OpenWrt 25.x and newer also need dnsmasq-full instead of the default dnsmasq. I do not have an apk-based router to test the exact replacement steps yet. If you know the correct procedure, please send a PR to improve these docs.
bash
# OpenWrt 25.x and newer
apk --update-cache add dnsmasq-full

# OpenWrt 24.x and older
opkg update && cd /tmp/ && opkg download dnsmasq-full
opkg remove dnsmasq; opkg install dnsmasq-full --cache /tmp/; rm -f /tmp/dnsmasq-full*.ipk;

Install from the repository page

Open the repository instructions page, select OpenWrt in the OS selector on the left, and use the generated commands for your exact version and architecture:

keen-pbr repository

Example install commands:

bash
# OpenWrt 25.x and newer
apk update
apk add keen-pbr

# or if you want headless version (without API and without WebUI)
# apk update
# apk add keen-pbr-headless
bash
# OpenWrt 24.x and older
opkg update
opkg install keen-pbr

# or if you want headless version (without API and without WebUI)
# opkg update
# opkg install keen-pbr-headless

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

Useful service commands:

bash
service keen-pbr start
service keen-pbr enable
service keen-pbr restart
If you do not plan to use the keen-pbr Web UI or API, you can install the keen-pbr-headless package instead. It uses less storage space (~1.2 MB instead of ~2.8 MB) and does not include the API server at all. Also, you can disable API server via config flag at any time on the full package version.

Next steps

Open Quick Start and use the Web UI tab for the easiest first setup. If you installed keen-pbr-headless, use the JSON / CLI tab instead.

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