[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Build Status][build-shield]][build-url]
[![Version][version-shield]][version-url]
[![Downloads][downloads-shield]][downloads-url]
Lux
A light desktop tun proxy client.lux-docs »
Download for macOS · Windows
- Motivation
- Getting Started
- Architecture
- Monorepo structure
- Roadmap
- Built With
- License
- Contact
- Sponsors
Motivation
There are many great proxy clients available on GitHub. However, some of them are a little hard to use or not open sourced. As a proxy tool, I think it should be easy to use. Open source technology is the only way to ensure we retain absolute control over the data.
Getting Started
See the docs for more.
Architecture
This project is using what I'm calling the "FGRT" stack (Flutter, Go, React, TypeScript).
- React on Flutter? Here flutter is not responsible for UI. It's more like a launcher: start the core process and open the webpage in browser.
- The core (itun2socks) is written in pure Go.
Monorepo structure
- itun2socks: The Go core, referred to internally as lux-core. Contains tun, networking stack and clash logic. Can be deployed in windows and macOS.
- lux-client: A React app using fluent-ui. It's the UI of lux.
- lux-rules: A Go utility tool used to generate built in proxy rules.
- lux-docs: The docs build with docusaurus.
Roadmap
- [x] Add splash screen
- [x] Improve UI of About page
- [x] Improve UI Dark mode
- [x] Support DNS over https
- [x] Support Mac OS
- [x] Support adding rules
- [ ] Support IPV6
See the open issues for a full list of proposed features (and known issues).
Built With
License
Distributed under the GPL License. See LICENSE.txt for more information.
Contact
Project Link: https://github.com/igoogolx/lux
Sponsors
Thanks to Jetbrains provided license!