Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: about 16 hours 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 (9 months ago)
Default Branch: main
Last Pushed: 2025-02-09T17:14:01.000Z (1 day ago)
Last Synced: 2025-02-09T18:25:16.926Z (1 day 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

        ![GitHub License](https://img.shields.io/github/license/nikkinikki-org/OpenWrt-nikki?style=for-the-badge&logo=github) ![GitHub Tag](https://img.shields.io/github/v/release/nikkinikki-org/OpenWrt-nikki?style=for-the-badge&logo=github) ![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/nikkinikki-org/OpenWrt-nikki/total?style=for-the-badge&logo=github) ![GitHub Repo stars](https://img.shields.io/github/stars/nikkinikki-org/OpenWrt-nikki?style=for-the-badge&logo=github) [![Telegram](https://img.shields.io/badge/Telegram-gray?style=for-the-badge&logo=telegram)](https://t.me/mugen_nikki)

# Nikki (formerly MihomoTProxy)

Transparent Proxy with Mihomo on OpenWrt.

## Prerequisites

- OpenWrt >= 23.05

- Linux Kernel >= 5.10

- firewall4

## Feature

- Transparent Proxy (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

curl -s -L 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 --allow-untrusted nikki

apk add --allow-untrusted luci-app-nikki

apk add --allow-untrusted luci-i18n-nikki-zh-cn

```

### B. Install From Release

```shell

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

```

## Uninstall & Reset

```shell

curl -s -L 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. Run hijack prepare script.

4. Set router hijack.

5. Set lan hijack with access control.

6. Set scheduled restart.

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 ipk/apk file will be found under `bin/packages/your_architecture/nikki`.

## Dependencies

- ca-bundle

- curl

- yq

- firewall4

- ip-full

- kmod-inet-diag

- kmod-nft-tproxy

- kmod-tun

## Contributors

[![Contributors](https://contrib.rocks/image?repo=nikkinikki-org/OpenWrt-nikki)](https://github.com/nikkinikki-org/OpenWrt-nikki/graphs/contributors)

## Special Thanks

- [@ApoisL](https://github.com/apoiston)

- [@xishang0128](https://github.com/xishang0128)