README

OpenFlux

English | Русский

Network stack research tool. IPv4 TCP/UDP tunnel with pluggable transports
(including a signed JS scripting engine for writing new ones), a batched +
zstd codec, and two exit-node backends (L3 raw forward / L4 gVisor proxy).

 Disclaimer

The author of OpenFlux does not encourage the use of this project to bypass
restrictions or violate the rules of any platform, and is not responsible
for the final scenarios of how users apply this tool in real life or on the
Internet. Any specific technical features of the application are nothing more
than an architectural coincidence, created without any intent.

The project is entirely non-commercial, contains no paid features, hidden
subscriptions, or commercial benefit.

The author is not responsible for forks, modifications, or derivative
versions of OpenFlux created by third parties. Any changes added to a fork are
the responsibility of its author.

The author is not responsible for:

- Any use of OpenFlux by third parties
- Consequences caused by the use of forks and modifications
- Damage resulting from derivative versions
- Violations committed using forks

The original code is provided as is, without any warranties.

 Clients

| Platform | Download | Notes |
|----------|----------|-------|
| macOS   | build from source | CLI + utun L3 client (--inbound=tun, default on macOS) |
| Linux   | build from source | CLI client (SOCKS5) / exit node (L3 or L4) |
| Windows | build from source | CLI client (SOCKS5, or --inbound=tun via Wintun - needs administrator) / exit node (l4, or l3 via QEMU - see docs) |
| Desktop | OpenFluxDesktop releases | Windows/macOS/Linux: full tunnel or SOCKS5/HTTP proxy, multi-transport sessions, encryption, an in-app node-deployment wizard over SSH |
| Android | OpenFluxAndroid releases | System-wide VPN or local SOCKS5, multi-transport sessions with failover, encryption, captcha handling in a built-in browser |
| Android | OpenFlux-Android releases | Fork: system-wide VPN or SOCKS5 proxy, multi-transport sessions, captcha handling, phone as exit node |
| iOS     | TestFlight beta | System-wide VPN via Network Extension |

 iOS app built by @saharev1 - full iOS client,
 TestFlight pipeline, system VPN support, DNS-over-TLS, and many stability fixes.
 HUGE thanks!

 OpenFlux-Android built by @damnurmum - an
 Android client with a system-wide VPN and a local SOCKS5 proxy mode, connection
 profiles, multi-transport sessions with failover (direct included), SmartCaptcha
 and login handling in a WebView (the exit node's too, passed through the tunnel
 from its address), the phone as an l4 exit node, Kill Switch and per-app and
 per-domain routing. Also contributed end-to-end encryption (38), the Mail.ru
 transport (60) and session resilience with exit captcha handling (93) to this
 repository. HUGE thanks!

 OpenFluxAndroid and OpenFluxDesktop run a Compose Multiplatform app and a
 shared module (multi-transport sessions, encryption, the built-in browser fo