What is gfw-router?

This repository holds the configuration files, build scripts, and bundled source code needed to turn a specific home router, the Cudy WR3000 v1, into a device that can route internet traffic around government level internet filtering, sometimes called the Great Firewall. It builds on top of an existing open source router firmware called ImmortalWrt, combined with a proxy tool called sing-box. Because the router's onboard storage is small, most of the software it needs is not kept permanently on the device. Instead, only a few small support packages are installed to the router's flash storage, and the larger programs, sing-box and a helper tool called clash2singbox, are downloaded into the router's memory each time it starts up. Clash2singbox takes a subscription link, the kind of link some proxy services hand out, and converts it into a format sing-box understands, doing this conversion locally on the router itself so no outside service ever sees that subscription link. Both of these bundled programs are rebuilt from their original source code so they work correctly on this router's particular operating system, rather than using the official prebuilt versions, which are not compatible. The repository automates keeping clash2singbox updated every day, while updates to sing-box are handled more carefully, since a mismatched version could break the whole setup, so a weekly check simply opens an issue rather than updating things automatically. The README also walks through the full setup process: flashing the router with the correct firmware, installing a handful of required packages over a remote terminal connection, configuring the router's firewall so traffic can flow through the proxy, turning off a networking feature that would otherwise conflict with the proxy, and optionally setting up a second, completely separate Wi-Fi network that bypasses the proxy altogether. Overall, this project is a personal networking and infrastructure setup rather than an app you install and run. It requires an SSH connection to the router, familiarity with basic command line tools, and a supported router model to be useful.