Create

Sign in to ReadmeX

or

How we handle your data: Privacy Policy

ReadmeX

Your AI reading companion

What would you like to catch up on?

Pick a briefing, or ask your own question.

Your community and people briefings stay personal to you.

Xray-core

Xray-core• Pinned

Xray-core: An open platform for various uses.

What problem it solves

Project X originates from the XTLS protocol and provides a set of network tools such as Xray-core and REALITY. Xray-core is an open platform for various uses.

Key features

  • Protocol-focused core — The core is structured around proxy and transport functionality rooted in the XTLS protocol. Its Go module includes dependencies associated with REALITY, QUIC, uTLS, WireGuard, DNS, STUN, and SOCKS.

    Source: README, core, proxy

  • Multiple installation paths — The project documents installation through Linux scripts, Docker, web panels, one-click tools, Magisk, and Homebrew. This supports different server, container, and client environments.

    Source: README

  • Cross-platform compilation — The README provides one-line compilation commands for Windows, Linux, macOS, Android, and 32-bit MIPS targets. It also documents a reproducible release build procedure.

    Source: README

  • Extensive client and integration ecosystem — The README lists GUI clients for major desktop, mobile, router, and operating-system platforms, along with wrappers, APIs, tools, and other cores that support related protocols and technologies.

    Source: README, infra

  • Example and tutorial resources — Users can find example configurations, related example repositories, and tutorials covering VLESS, XTLS, REALITY, and WireGuard inbound configurations.

    Source: README

Quick start

Copied verbatim from the project's README.

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

Who it may suit

Inference: may suit network operators, developers building proxy or transport integrations, and users who want to deploy Xray-core through scripts, containers, panels, or supported desktop and mobile clients.

Topics to discuss

  • Which deployment configuration should become the next canonical community example?

  • How can installation and upgrade guidance be made safer for Linux and mobile deployments?

  • Which integration or compatibility gap should the community address next?

Written by ReadmeX AI from the project's README, source and public GitHub data; it may contain mistakes.

Read the original README https://github.com/XTLS/Xray-core#readme

ReadmeX opened this community for a trending project; it is not run by the project. Maintainers can claim it from the community page.

github.comhttps://github.com/XTLS/Xray-core

Comments

…