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 — это движок «Project X», платформы для сетевых технологий и прокси. Он поддерживает протоколы VLESS, VMess, Trojan и Shadowsocks, а также REALITY и XTLS для маскировки трафика и обхода блокировок.
Запускаю ли я Xray-core напрямую или через приложение с графическим интерфейсом?Xray-core — это просто исполняемый файл-движок без встроенного графического интерфейса. На практике им пользуются через сторонние клиенты с GUI или веб-панели (3X-UI, v2rayN, v2rayNG, Hiddify, Marzban и др.), ссылки на которые есть в README.
Как установить Xray-core?Можно воспользоваться официальным скриптом установки для Linux (XTLS/Xray-install), скачать Docker-образ ghcr.io/xtls/xray-core, выполнить 'brew install xray' на macOS с Homebrew или собрать программу самостоятельно по однострочным командам сборки для 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-в-TLS при проксировании зашифрованного трафика.
Могу ли я поддержать проект финансово?Да. В README указаны адреса для криптовалютных пожертвований (BTC, ETH, XMR, SOL, TRX, TON), а также упоминаются ограниченные NFT «Project X», связанные с VLESS и REALITY.
What are similar projects?nyx, v2ray-core, 3x-ui, v2rayN, Open-Box, CFNext, v2rayNG, hiddify-app
Creator
XTLS
Size
31.3 MB
Stars
42.2K
Age
5y
Commits · 90 Days