Skip to content

igoogolx/lux

Repository files navigation


Logo

Contributors Forks Stargazers Issues MIT License Build Status Version Downloads

Lux

A light desktop proxy app.
lux-docs »

Download for macOS(require macOS 13+) · Windows(require webview2)

Report Bug · Request Feature

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.

(back to top)

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 webview.
  • 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

  • Add splash screen
  • Improve UI of About page
  • Improve UI Dark mode
  • Support DNS over https
  • Support Mac OS
  • Support adding rules
  • Support IPV6

See the open issues for a full list of proposed features (and known issues).

(back to top)

Built With

  • React
  • Flutter
  • Go

(back to top)

Acknowledgement

Lux was based on or inspired by these projects and so on:

  • sing-tun: Simple transparent proxy library.
  • outline-sdk: SDK to build network tools based on Outline components.
  • clash-verge-rev: A modern GUI client based on Tauri, designed to run in Windows, macOS and Linux for tailored proxy experience.

(back to top)

License

Distributed under the GPL License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/igoogolx/lux

(back to top)

Sponsors

JetBrains logo.

Thanks to Jetbrains provided license!

(back to top)