README.md

Project X

Project X originates from XTLS protocol, providing a set of network tools such as Xray-core and REALITY.

README is open, so feel free to submit your project here.

License

Mozilla Public License Version 2.0

Documentation

Project X Official Website

Telegram

Project X

Project X Channel

Installation

• Linux Script
  • XTLS/Xray-install
• Docker
  • teddysun/xray
• Web Panel
  • X-UI, X-UI-English, 3X-UI, X-UI, X-UI
  • Xray-UI, X-UI
  • Hiddify
  • Marzban
  • Libertea
• One Click
  • Xray-script, Xray-REALITY, LetsXray
  • XTool, Xray_bash_onekey, xray-reality
  • v2ray-agent, Xray_onekey, ProxySU
• Magisk
  • Xray4Magisk
  • Xray_For_Magisk
• Homebrew
  • brew install xray

Usage

• Example
  • VLESS-XTLS-uTLS-REALITY
  • VLESS-TCP-XTLS-Vision
  • All-in-One-fallbacks-Nginx
• Xray-examples
  • XTLS/Xray-examples
  • chika0801/Xray-examples
  • lxhao61/integrated-examples
• Tutorial
  • XTLS Vision
  • REALITY (English)
  • XTLS-Iran-Reality (English)

GUI Clients

• OpenWrt
  • PassWall, PassWall 2
  • ShadowSocksR Plus+
  • luci-app-xray (openwrt-xray)
• Windows
  • v2rayN
  • Invisible Man - Xray
• Android
  • v2rayNG
  • X-flutter
• iOS & macOS arm64
  • Mango
  • Wings X
• macOS arm64 & x64
  • V2RayXS
  • Wings X

Others that support VLESS, XTLS, REALITY, XUDP, PLUX...

• iOS & macOS arm64
  • Shadowrocket
  • Stash
• Xray Wrapper
  • xtlsapi
  • AndroidLibXrayLite
  • XrayKit
  • libxray
• XrayR
  • XrayR-release
  • XrayR-V2Board
• Clash.Meta
  • Clash Verge
  • clashN
  • Clash Meta for Android
  • meta_for_ios
• sing-box
  • installReality
  • sbox-reality
  • sing-box-for-ios

Contributing

Code of Conduct

Credits

This repo relies on the following third-party projects:

• Special thanks:
  • v2fly/v2ray-core
• In production:
  • ghodss/yaml
  • gorilla/websocket
  • quic-go/quic-go
  • pelletier/go-toml
  • pires/go-proxyproto
  • refraction-networking/utls
  • seiflotfy/cuckoofilter
  • google/starlark-go
• For testing only:
  • miekg/dns
  • stretchr/testify
  • h12w/socks

Compilation

Windows

go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main

Linux / macOS

go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main

Stargazers over time