LAN Proxy Gateway

Turn one computer into a LAN-wide proxy gateway. Configure proxies once on the gateway machine, and every device in your house (phone / Switch / PS5 / Apple TV / smart TV) uses them — no proxy app needed on each device.

Menu-driven CLI · one-line install · built-in Gateway web dashboard. Built on mihomo (Clash.Meta). 中文: README.md

flowchart LR
    subgraph LAN["🏠 Home LAN"]
        direction TB
        S[🎮 Switch / PS5 / Apple TV]
        M[📱 iPhone / Android / TV box]
        PC[💻 Other computers]
    end
    GW["🖥️ Gateway computer

mihomo · TUN · rule-based routing"]
    SRC["🌐 Proxy source

subscription / local config / single proxy"]
    LAN -- "Change gateway, or set proxy" --> GW --> SRC

    style LAN fill:#fff5e6,stroke:#ff9900
    style GW fill:#e6f3ff,stroke:#0066cc
    style SRC fill:#e6ffe6,stroke:#00aa00

⚡ 3-Minute Quick Start

1. Install

# macOS / Linux
curl -fsSL https://raw.githubusercontent.com/Tght1211/lan-proxy-gateway/main/install.sh | bash

# Windows (Administrator PowerShell)
irm https://raw.githubusercontent.com/Tght1211/lan-proxy-gateway/main/install.ps1 | iex

The script walks you through a setup wizard (proxy source → start → optional auto-start). If GitHub is slow from your network, set GITHUB_MIRROR=https://your-mirror/, or if you already have Clash running locally, export HTTP_PROXY=http://127.0.0.1:7897 first.

2. Start

sudo gateway start     # macOS / Linux
gateway start          # Windows (Administrator terminal, no sudo)

The console shows the LAN IP and proxy port — that's what your other devices will point at.

3. Connect devices

⚠️ Windows Home limitation: no RRAS, ICS is locked to 192.168.137/24, so "change gateway" mode does not work. All devices must use the "set HTTP proxy" path. Switch / PS5 / Apple TV / smart TVs that can only take a gateway (not a proxy) cannot be served from a Windows host — use Linux / macOS or a soft router instead.

Detailed walkthroughs (with screenshots): docs/en/ — phone / switch / ps5 / appletv / tv

✨ What it does

🎯 Who it's for

• 🎮 You want proxies on Switch / PS5 / Apple TV / smart TV — these devices have no proxy app to install, only a gateway field. Common uses: Switch online play, eShop / PSN downloads, Steam / Epic / Xbox downloads
• 📱 You don't want a VPN app on your phone — set the Wi-Fi proxy to your home gateway and you're done
• 👨‍👩‍👧 One household subscription, all devices — keep the subscription on one machine, every other device joins with zero config
• 🔁 Augment Clash Verge / V2RayN / Mihomo Party — reuse the running client's node pool; bolt on chains, LAN sharing, and TUN gateway without replacing it

Detailed scenarios + traffic-path diagrams: docs/scenarios.md (Chinese)

🆚 vs. Clash Verge's "LAN Access"

📚 Documentation

Device setup

• phone-setup · switch-setup · ps5-setup · appletv-setup · tv-setup

Commands & config

• commands.md — full CLI reference and menu map
• advanced.md — config schema & tuning
• faq.md
• versioning.md

🔄 Update / rollback

gateway update                 # latest release (recommended: do NOT pre-sudo)
gateway update latest          # same as above
gateway update v3.4.3          # specific tag (or rollback)

Since v3.4.9, don't pre-sudo: the command runs version lookup and asset download under your user identity (preserving HTTPS_PROXY etc.), then requests sudo only for the stop/replace/restart step. sudo gateway update still works, but macOS's default sudoers strips proxy variables, so GitHub becomes unreachable.

First time upgrading from a pre-v3.4.3 install (no gateway update subcommand yet), just re-run the install script — it overwrites in place and preserves your gateway.yaml:

curl -fsSL https://raw.githubusercontent.com/Tght1211/lan-proxy-gateway/main/install.sh | sudo bash

🛠️ Local Development

./dev.sh build        # writes .tmp/gateway-dev
./dev.sh test         # go test ./...
./dev.sh test-core    # smaller core package set
./dev.sh run -- --version
./dev.sh start        # builds locally, sudo only for the runtime step

The Go build cache defaults to .cache/go-build inside the repo to avoid global-cache permission issues.

📜 License

MIT © 2025-2026 Tght1211 Built on mihomo + metacubexd.

⭐ Star History