Xray-core README

The project's README from github.com/XTLS/Xray-core. As one markdown file: 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.

Sponsors

Remnawave

Happ

BlancVPN

Sponsor Xray-core

Donation & NFTs

Collect a Project X NFT to support the development of Project X!

Project X NFT

License

Mozilla Public License Version 2.0

Documentation

Project X Official Website

Telegram

Project X

Project X Channel

Project VLESS (Русский)

Project XHTTP (Persian)

Installation

Usage

GUI Clients

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

Contributing

Code of Conduct

Ask DeepWiki

Credits

Bundled Third-Party Components Redistribution

Certain optional features dynamically load third-party components. These optional components are separate works distributed under their own licenses, and are bundled into the ZIP package for ease of use. Users may replace these components under the licenses from these components.

These components include:

Wintun

This distribution contains unmodified official precompiled and pre-signed Wintun binaries.

One-line Compilation

Windows (PowerShell)

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

Linux / macOS

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

Reproducible Releases

Make sure that you are using the same Go version, and remember to set the git commit id (7 bytes):

CGO_ENABLED=0 go build -o xray -trimpath -buildvcs=false -gcflags="all=-l=4" -ldflags="-X github.com/xtls/xray-core/core.build=REPLACE -s -w -buildid=" -v ./main

For Android:

GOOS=android GOARCH=arm64 CGO_ENABLED=1 CC=/path/to/aarch64-linux-android24-clang go build -o xray -trimpath -buildvcs=false -gcflags="all=-l=4" -ldflags="-X github.com/xtls/xray-core/core.build=REPLACE -s -w -buildid= -checklinkname=0" -v ./main
GOOS=android GOARCH=amd64 CGO_ENABLED=1 CC=/path/to/x86_64-linux-android24-clang go build -o xray -trimpath -buildvcs=false -gcflags="all=-l=4" -ldflags="-X github.com/xtls/xray-core/core.build=REPLACE -s -w -buildid= -checklinkname=0" -v ./main

If you are compiling a 32-bit MIPS/MIPSLE target, use this command instead:

CGO_ENABLED=0 go build -o xray -trimpath -buildvcs=false -gcflags="-l=4" -ldflags="-X github.com/xtls/xray-core/core.build=REPLACE -s -w -buildid=" -v ./main

Stargazers over time

Stargazers over time

Xray-core (XTLS/Xray-core)

Searching Database…

42.2K ·GitHub
Xray-core
What is this?Xray-core is the engine of 'Project X', a networking/proxy platform that implements protocols like VLESS, VMess, Trojan and Shadowsocks, with REALITY and XTLS for traffic obfuscation and censorship circumvention.
Do I run Xray-core directly, or through a GUI app?Xray-core itself is a core binary/engine with no built-in GUI. In practice people run it through third-party GUI clients or web panels (3X-UI, v2rayN, v2rayNG, Hiddify, Marzban, etc.) that the README links to.
How do I install Xray-core?Use the official Linux install script (XTLS/Xray-install), pull the Docker image ghcr.io/xtls/xray-core, run 'brew install xray' on macOS/Homebrew, or compile it yourself with the one-line build commands for Windows/Linux/macOS.
Is there anything special about the Windows build?The Windows package bundles the official precompiled Wintun driver (wintun.dll) to enable TUN inbound mode, but it's a separately-licensed, optional component only loaded at runtime on supported Windows systems.
Which platforms can actually run this?Xray-core compiles for Windows, Linux and macOS, and the README lists official and third-party clients that cover Android, iOS/macOS/tvOS, OpenWrt and even HarmonyOS.
What is REALITY?REALITY is one of Project X's anti-detection protocols that makes proxy traffic mimic a real TLS handshake with a legitimate website, making it much harder for censors to fingerprint and block.
How is Xray-core related to v2ray-core?Xray-core v1.0.0 was forked from v2fly/v2ray-core and has since accumulated many protocol and performance enhancements documented in its release notes.
What is XTLS Vision?XTLS Vision is a transport mode shown in the README's usage examples (VLESS-TCP-XTLS-Vision) that reduces the overhead of TLS-in-TLS when proxying encrypted traffic.
Can I support the project financially?Yes, the README lists crypto donation addresses (BTC, ETH, XMR, SOL, TRX, TON) and mentions limited 'Project X' NFTs tied to VLESS and REALITY.
What are similar projects?nyx, v2ray-core, 3x-ui, v2rayN, Open-Box, CFNext, v2rayNG, hiddify-app
Which topics is it in?xtls, reality, anticensorship, vision, xray, vmess, vless, wireguard, trojan, network, socks5, v2ray
Creator
XTLS
Size
31.3 MB
Stars
42.2K
Updated
CommitOct 17Releasev26.3.27Mar 27
Age
5y
Commits · 90 Days