https://github.com/nikkinikki-org/OpenWrt-nikki
Transparent Proxy with Mihomo on OpenWrt.
https://github.com/nikkinikki-org/OpenWrt-nikki
clash clashmeta luci-app luci-app-mihomo mihomo openwrt transparent-proxy
Last synced: 19 days ago
JSON representation
Transparent Proxy with Mihomo on OpenWrt.
- Host: GitHub
- URL: https://github.com/nikkinikki-org/OpenWrt-nikki
- Owner: nikkinikki-org
- License: gpl-3.0
- Created: 2024-05-11T08:59:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-09T17:14:01.000Z (9 months ago)
- Last Synced: 2025-02-09T18:25:16.926Z (9 months ago)
- Topics: clash, clashmeta, luci-app, luci-app-mihomo, mihomo, openwrt, transparent-proxy
- Language: Shell
- Homepage:
- Size: 616 MB
- Stars: 1,790
- Watchers: 12
- Forks: 191
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
    [](https://t.me/nikkinikki_org)
English | [中文](README.zh.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
```shell
# only needs to be run once
wget -O - https://github.com/nikkinikki-org/OpenWrt-nikki/raw/refs/heads/main/feed.sh | ash
```
2. Install
```shell
# 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
```shell
wget -O - https://github.com/nikkinikki-org/OpenWrt-nikki/raw/refs/heads/main/install.sh | ash
```
## Uninstall & Reset
```shell
wget -O - https://github.com/nikkinikki-org/OpenWrt-nikki/raw/refs/heads/main/uninstall.sh | ash
```
## How To Use
See [Wiki](https://github.com/nikkinikki-org/OpenWrt-nikki/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
```shell
# 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
[](https://github.com/nikkinikki-org/OpenWrt-nikki/graphs/contributors)
## Special Thanks
- [@ApoisL](https://github.com/apoiston)
- [@xishang0128](https://github.com/xishang0128)
## Recommended Proxy Provider
Perfect Link is recommended
All route on IEPL, All exit node at Akari, reliable and easy to use
[Official Website](https://perfectlink.io) | [Customer Service](https://t.me/PerfectlinksupportBot)