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
这是什么？Xray-core 是 “Project X” 的核心引擎。“Project X” 是一个网络代理平台，实现了 VLESS、VMess、Trojan 和 Shadowsocks 等协议，并借助 REALITY 和 XTLS 对流量进行混淆，以帮助绕过审查。
我是直接运行 Xray-core，还是通过图形界面应用来用？Xray-core 本身是核心程序（二进制文件/引擎），没有内置图形界面。实际使用中，人们通常通过第三方图形客户端或网页面板来运行它，例如 3X-UI、v2rayN、v2rayNG、Hiddify、Marzban 等，这些在 README 中都有链接。
我该怎么安装 Xray-core？可以使用官方的 Linux 安装脚本（XTLS/Xray-install），拉取 Docker 镜像 ghcr.io/xtls/xray-core，在 macOS/Homebrew 上运行 'brew install xray'，或者使用适用于 Windows/Linux/macOS 的一行编译命令自行编译。
Windows 版本有什么特别之处吗？Windows 安装包内置了官方预编译的 Wintun 驱动（wintun.dll），用于启用 TUN 入站模式。但它是单独授权的可选组件，只有在受支持的 Windows 系统上运行时才会加载。
哪些平台真正能运行它？Xray-core 可以在 Windows、Linux 和 macOS 上编译。README 中列出的官方及第三方客户端还覆盖 Android、iOS/macOS/tvOS、OpenWrt，甚至 HarmonyOS。
REALITY 是什么？REALITY 是 Project X 的一种反检测协议，它让代理流量模仿与正规网站之间真实的 TLS 握手，使审查者更难识别其特征并加以封锁。
Xray-core 和 v2ray-core 是什么关系？Xray-core v1.0.0 派生自 v2fly/v2ray-core，此后在协议和性能方面增加了许多改进，详见其发布说明。
什么是 XTLS Vision？XTLS Vision 是 README 用法示例中出现的一种传输模式（VLESS-TCP-XTLS-Vision），可降低代理加密流量时 TLS-in-TLS 的额外开销。
我可以捐助这个项目吗？可以。README 列出了加密货币捐赠地址（BTC、ETH、XMR、SOL、TRX、TON），并提到了与 VLESS 和 REALITY 相关的限量版 “Project X” NFT。
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