Skip to content

Repository files navigation

JustClash

License: GPL-2.0 OpenWrt Compatibility
Latest JustClash release Latest JustClash RC release Latest Mihomo release

JustClash logo

Native OpenWrt traffic orchestration service and LuCI interface for managing Mihomo routing, outbounds, and lifecycle—without requiring a third-party dashboard.

Quick start · Routing architecture · Security concerns · Update / backup / remove · UCI reference · Disclaimer

Important

JustClash manages local routing and runtime configuration. It does not provide remote servers, subscriptions, access credentials, or preconfigured external routing destinations.

Caution

Disclaimer / Отказ от ответственности

This non-commercial educational and technical research project is provided “AS IS”. Read the full bilingual Disclaimer / Отказ от ответственности, including compliance, liability, and trademark terms, before use.

About

JustClash connects OpenWrt's native UCI configuration system with the Mihomo runtime. It compiles router settings into a working core configuration, manages the service lifecycle, and installs the required firewall and DNS hooks.

The LuCI application provides service controls, node selection, active connections, rules, traffic statistics, and realtime logs. The service can also be managed entirely through UCI, init scripts, and the command line.

Highlights

Capability Description
Native OpenWrt integration UCI configuration, procd supervision, fw4/nftables hooks, and LuCI CSR views
Full and partial routing Choose complete traffic interception or selective lower-overhead routing
Runtime control Switch nodes, inspect rules and connections, terminate sockets, and view live logs
Mihomo-native providers Proxy providers and rule providers are downloaded and updated by the core
APK and IPK packages OpenWrt 25.x is the primary APK target; OpenWrt 24.x remains supported through IPK
Headless management LuCI is optional for users who prefer UCI and CLI administration

Getting Started

  1. Follow the Quick Start to install the packages and create the first outbound.
  2. Read Choosing a Routing Mode before selecting full or partial routing.
  3. Use the UCI structure reference for manual configuration.

The online installer detects the router package manager automatically. Interactive installation asks only which translation package should be installed; automated installation uses the English LuCI package without an additional translation.

New installations use the slim kernel version of Mihomo by default. The core repository remains editable in LuCI.

Documentation

Core Reference

Guide Covers
Quick Start Installation, routing mode, outbounds, groups, and first launch
Routing Architecture Full and partial routing, DNS, Fake-IP, TProxy, TUN, IPv6, and mode changes
Security Concerns Generated API passwords, download User-Agents, controller exposure, TLS, dashboards, and CORS
Update, Backup, and Removal Package and core updates, SHA256 verification, backup, restore, rollback, and removal
UCI Configuration Complete configuration structure and section reference
Command-Line Reference Service maintenance, diagnostics, configuration display, and updates from the shell
ubus API rpcd methods, request parameters, responses, ACL classes, and LuCI integration

Routing and Rules

Guide Covers
Traffic Exclusions Router and LAN bypass rules by mark, owner, address, port, or client
User-Defined RuleSets Custom sources, activation, caching, and partial-routing requirements
Block Rules Domain and address blocking, limitations, and verification
Geodata, Geosite, and GeoIP Policy types, update sources, Fake-IP filters, and verification

Network Scenarios

Guide Covers
Mixed Port HTTP/SOCKS listener setup, client configuration, and security
Guest Network Intercepted or direct guest networks and filtered DNS
Multi-WAN and Failover Interface binding, failover, latency selection, and balancing

Operations and Security

Guide Covers
Startup and WAN Troubleshooting WAN readiness, delayed startup, time synchronization, and recovery order

Architecture

flowchart LR
    Settings[UCI and LuCI settings] --> Compiler[JustClash compiler]
    Compiler --> Runtime[Mihomo configuration]
    Compiler --> Network[nftables and DNS hooks]
    Runtime --> Core[Mihomo core]
    Core --> Control[LuCI and CLI control]
    Core --> Providers[Proxy and rule providers]
Loading

The service owns the complete lifecycle: validation, configuration compilation, firewall setup, core supervision, and cleanup. More detail is available in Routing Architecture.

Screenshots

JustClash status dashboard

Interface gallery
Nodes Routing
Node selection Routing configuration
Connections Rulesets
Active connections Ruleset configuration
Service logs Realtime logs
Service logs Realtime logs

Compatibility

Supports OpenWrt 24.x (OPKG/IPK) and 25.x (APK). See the Quick Start for installation instructions.

License

Licensed under the GPL-2.0 License.

About

Native OpenWrt traffic orchestration service and LuCI interface for managing Mihomo routing, outbounds, and lifecycle without requiring a third-party dashboard.

Resources

Stars

26 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages