xray-core

module

v1.0.1-0...-9b55815 Latest Latest Go to latest Published: Nov 22, 2024 License: MPL-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/rosebe/xray-core

README ¶

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.

Project VLESS (non-Chinese)

Installation

Linux Script
- XTLS/Xray-install (Official)
- tempest (supports systemd and OpenRC; Linux-only)
Docker
- ghcr.io/xtls/xray-core (Official)
- teddysun/xray
- wulabing/xray_docker
Web Panel - WARNING: Please DO NOT USE plain HTTP panels like 3X-UI, as they are believed to be bribed by Iran GFW for supporting plain HTTP by default and refused to change (https://github.com/XTLS/Xray-core/pull/3884#issuecomment-2439595331), which has already put many users' data security in danger in the past few years. If you are already using 3X-UI, please switch to the following panels, which are verified to support HTTPS and SSH port forwarding only:
- Marzban
- Xray-UI
- Hiddify
One Click
Magisk
- Xray4Magisk
- Xray_For_Magisk
Homebrew
- brew install xray

Usage

GUI Clients

OpenWrt
Windows
Android
iOS & macOS arm64
- FoXray
- Streisand
macOS arm64 & x64
- V2rayU
- V2RayXS
- Furious
- FoXray
Linux
- v2rayA
- Furious

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

iOS & macOS arm64
- Shadowrocket
Xray Tools
- xray-knife
Xray Wrapper
XrayR
- XrayR-release
- XrayR-V2Board
Clash.Meta
- clashN
- Clash Meta for Android
sing-box

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

Directories ¶

Path	Synopsis
app Package app contains feature implementations of Xray.	Package app contains feature implementations of Xray.
commander
dispatcher
dns Package dns is an implementation of core.DNS feature.	Package dns is an implementation of core.DNS feature.
dns/fakedns
log
log/command
metrics
observatory
observatory/burst
observatory/command
policy Package policy is an implementation of policy.Manager feature.	Package policy is an implementation of policy.Manager feature.
proxyman
proxyman/command
proxyman/inbound
proxyman/outbound
reverse
router
router/command
stats
stats/command
common Package common contains common utilities that are shared among other packages.	Package common contains common utilities that are shared among other packages.
antireplay
bitmask
buf Package buf provides a light-weight memory allocation mechanism.	Package buf provides a light-weight memory allocation mechanism.
bytespool
cache
cmdarg
crypto Package crypto provides common crypto libraries for Xray.	Package crypto provides common crypto libraries for Xray.
crypto/internal
ctx
dice Package dice contains common functions to generate random number.	Package dice contains common functions to generate random number.
drain
errors Package errors is a drop-in replacement for Golang lib 'errors'.	Package errors is a drop-in replacement for Golang lib 'errors'.
log
mux
net Package net is a drop-in replacement to Golang's net package, with some more functionalities.	Package net is a drop-in replacement to Golang's net package, with some more functionalities.
net/cnc
ocsp
peer
platform
platform/ctlcmd
platform/filesystem
protocol
protocol/bittorrent
protocol/dns
protocol/http
protocol/quic
protocol/tls
protocol/tls/cert
protocol/udp
reflect
retry
serial
session Package session provides functions for sessions of incoming requests.	Package session provides functions for sessions of incoming requests.
signal
signal/done
signal/pubsub
signal/semaphore
singbridge
strmatcher
task
units
uuid
xudp
core Package core provides an entry point to use Xray core functionalities.	Package core provides an entry point to use Xray core functionalities.
features
dns
dns/localdns
extension
inbound
outbound
policy
routing
routing/dns
routing/session
stats
infra
conf
conf/cfgcommon/duration
conf/json
conf/serial
vformat
vprotogen
main
commands/all
commands/all/api
commands/all/convert
commands/all/tls
commands/base Package base defines shared basic pieces of the commands, in particular logging and the Command structure.	Package base defines shared basic pieces of the commands, in particular logging and the Command structure.
confloader
confloader/external
distro/all
distro/debug
json
toml
yaml
proxy Package proxy contains all proxies used by Xray.	Package proxy contains all proxies used by Xray.
blackhole Package blackhole is an outbound handler that blocks all connections.	Package blackhole is an outbound handler that blocks all connections.
dns
dokodemo
freedom
http
loopback
shadowsocks Package shadowsocks provides compatible functionality to Shadowsocks.	Package shadowsocks provides compatible functionality to Shadowsocks.
shadowsocks_2022
socks Package socks provides implements of Socks protocol 4, 4a and 5.	Package socks provides implements of Socks protocol 4, 4a and 5.
trojan
vless Package vless contains the implementation of VLess protocol and transportation.	Package vless contains the implementation of VLess protocol and transportation.
vless/encoding
vless/inbound
vless/outbound
vmess Package vmess contains the implementation of VMess protocol and transportation.	Package vmess contains the implementation of VMess protocol and transportation.
vmess/aead
vmess/encoding
vmess/inbound
vmess/outbound
wireguard
wireguard/gvisortun
testing
mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
scenarios
servers/http
servers/tcp
servers/udp
transport
internet
internet/browser_dialer
internet/grpc
internet/grpc/encoding
internet/headers/dns
internet/headers/http
internet/headers/noop
internet/headers/srtp
internet/headers/tls
internet/headers/utp
internet/headers/wechat
internet/headers/wireguard
internet/http
internet/httpupgrade
internet/kcp Package kcp - A Fast and Reliable ARQ Protocol	Package kcp - A Fast and Reliable ARQ Protocol
internet/reality
internet/splithttp
internet/stat
internet/tagged
internet/tagged/taggedimpl
internet/tcp
internet/tls
internet/udp
internet/websocket Package websocket implements WebSocket transport	Package websocket implements WebSocket transport
pipe

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL