README.md

Nikki

Transparent Proxy with Mihomo on OpenWrt.

Prerequisites

• OpenWrt >= 23.05
• Linux Kernel >= 5.13
• firewall4

Feature

• Transparent Proxy (Redirect/TPROXY/TUN, IPv4 and/or IPv6)
• Access Control
• Profile Mixin
• Profile Editor
• Scheduled Restart

Install & Update

A. Install From Feed (Recommended)

1. Add Feed

# only needs to be run once
curl -s -L https://github.com/nikkinikki-org/OpenWrt-nikki/raw/refs/heads/main/feed.sh | ash

2. Install

# you can install from shell or `Software` menu in LuCI
# for opkg
opkg install nikki
opkg install luci-app-nikki
opkg install luci-i18n-nikki-zh-cn
# for apk
apk add --allow-untrusted nikki
apk add --allow-untrusted luci-app-nikki
apk add --allow-untrusted luci-i18n-nikki-zh-cn

B. Install From Release

curl -s -L https://github.com/nikkinikki-org/OpenWrt-nikki/raw/refs/heads/main/install.sh | ash

Uninstall & Reset

curl -s -L https://github.com/nikkinikki-org/OpenWrt-nikki/raw/refs/heads/main/uninstall.sh | ash

How To Use

See Wiki

How does it work

1. Mixin and Update profile.
2. Run mihomo.
3. Set scheduled restart.
4. Set ip rule/route
5. Generate nftables and apply it.

Note that the steps above may change base on config.

Compilation

# add feed
echo "src-git nikki https://github.com/nikkinikki-org/OpenWrt-nikki.git;main" >> "feeds.conf.default"
# update & install feeds
./scripts/feeds update -a
./scripts/feeds install -a
# make package
make package/luci-app-nikki/compile

The package files will be found under bin/packages/your_architecture/nikki.

Dependencies

• ca-bundle
• curl
• yq
• firewall4
• ip-full
• kmod-inet-diag
• kmod-nft-socket
• kmod-nft-tproxy
• kmod-tun

Contributors

Special Thanks

• @ApoisL
• @xishang0128