OpenWrt-nikki Documentation

Technical Documentation: nikkinikki-org/OpenWrt-nikki

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

English | 中文

Nikki

Transparent Proxy with Mihomo on OpenWrt.

Prerequisites Copy Chapter

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

Feature Copy Chapter

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

Install & Update Copy Chapter

A. Install From Feed (Recommended) Copy Section

1. Add Feed

# only needs to be run once
wget -O - 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 nikki
apk add luci-app-nikki
apk add luci-i18n-nikki-zh-cn

B. Install From Release Copy Section

wget -O - https://github.com/nikkinikki-org/OpenWrt-nikki/raw/refs/heads/main/install.sh | ash

Uninstall & Reset Copy Chapter

wget -O - https://github.com/nikkinikki-org/OpenWrt-nikki/raw/refs/heads/main/uninstall.sh | ash

How To Use Copy Chapter

See Wiki

How does it work Copy Chapter

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 Copy Chapter

# 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 Copy Chapter

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

Contributors Copy Chapter

Special Thanks Copy Chapter

• @ApoisL
• @xishang0128

--- METRICS ---

• Files Extracted: 1
• Estimated Token Budget: ~517 tokens
• Canonical Reference: https://codewiki.google/github.com/nikkinikki-org/OpenWrt-nikki