Xray-core/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
  • team-cloudchaser/tempest (supports systemd and OpenRC; Linux-only)
• Docker
  • Official: ghcr.io/xtls/xray-core
  • iamybj/docker-xray
  • teddysun/xray
• Web Panel
  • X-UI-English, 3X-UI, X-UI, X-UI
  • Xray-UI, X-UI
  • Hiddify
  • Marzban
  • Libertea
• One Click
  • Xray-REALITY, xray-reality, reality-ezpz
  • Xray_bash_onekey, XTool
  • 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)
  • Xray REALITY with 'steal oneself' (English)
  • Xray with WireGuard inbound (English)

GUI Clients

• OpenWrt
  • PassWall, PassWall 2
  • ShadowSocksR Plus+
  • luci-app-xray (openwrt-xray)
• Windows
  • v2rayN
  • NekoRay
  • Furious
  • HiddifyN
  • Invisible Man - Xray
• Android
  • v2rayNG
  • HiddifyNG
  • X-flutter
• iOS & macOS arm64
  • FoXray
  • Streisand
• macOS arm64 & x64
  • V2rayU
  • V2RayXS
  • Furious
  • FoXray
• Linux
  • v2rayA
  • NekoRay
  • Furious

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

• iOS & macOS arm64
  • Shadowrocket
• Xray Tools
  • xray-knife
• Xray Wrapper
  • XTLS/libXray
  • xtlsapi
  • AndroidLibXrayLite
  • XrayKit
  • Xray-core-python
  • xray-api
• 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

• Xray-core v1.0.0 was forked from v2fly-core 9a03cc5, and we have made & accumulated a huge number of enhancements over time, check the release notes for each version.
• For third-party projects used in Xray-core, check your local or the latest go.mod.

Compilation

Windows (PowerShell)

$env:CGO_ENABLED=0
go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main

Linux / macOS

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

Reproducible Releases

make

Stargazers over time