README
¶
Project X
Project X originates from XTLS protocol, provides a set of network tools such as Xray-core and Xray-flutter.
License
Mozilla Public License Version 2.0
Installation
- Linux Script
- Docker
- teddysun/xray
- Xray-docker
- One Click
- Magisk
- Homebrew
brew install xray- (Tap) Repository 0
- (Tap) Repository 1
Contributing
Usage
Xray-examples / VLESS-TCP-XTLS-WHATEVER
GUI Clients
- OpenWrt
- Windows
- v2rayN
- Qv2ray (This project had been archived and currently inactive)
- Netch (NetFilter & TUN/TAP) (This project had been archived and currently inactive)
- Android
- iOS & macOS (with M1 chip)
- macOS (Intel chip & M1 chip)
Credits
This repo relies on the following third-party projects:
- Special thanks:
- In production:
- For testing only:
Compilation
Windows
go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main
Linux / macOS
go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main
Telegram
Stargazers over time
Directories
¶
| Path | Synopsis |
|---|---|
|
Package app contains feature implementations of Xray.
|
Package app contains feature implementations of Xray. |
|
dns
Package dns is an implementation of core.DNS feature.
|
Package dns is an implementation of core.DNS feature. |
|
policy
Package policy is an implementation of policy.Manager feature.
|
Package policy is an implementation of policy.Manager feature. |
|
Package common contains common utilities that are shared among other packages.
|
Package common contains common utilities that are shared among other packages. |
|
buf
Package buf provides a light-weight memory allocation mechanism.
|
Package buf provides a light-weight memory allocation mechanism. |
|
crypto
Package crypto provides common crypto libraries for Xray.
|
Package crypto provides common crypto libraries for Xray. |
|
dice
Package dice contains common functions to generate random number.
|
Package dice contains common functions to generate random number. |
|
errors
Package errors is a drop-in replacement for Golang lib 'errors'.
|
Package errors is a drop-in replacement for Golang lib 'errors'. |
|
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. |
|
session
Package session provides functions for sessions of incoming requests.
|
Package session provides functions for sessions of incoming requests. |
|
Package core provides an entry point to use Xray core functionalities.
|
Package core provides an entry point to use Xray core functionalities. |
|
infra
|
|
|
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. |
|
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. |
|
shadowsocks
Package shadowsocks provides compatible functionality to Shadowsocks.
|
Package shadowsocks provides compatible functionality to Shadowsocks. |
|
socks
Package socks provides implements of Socks protocol 4, 4a and 5.
|
Package socks provides implements of Socks protocol 4, 4a and 5. |
|
vless
Package vless contains the implementation of VLess protocol and transportation.
|
Package vless contains the implementation of VLess protocol and transportation. |
|
vmess
Package vmess contains the implementation of VMess protocol and transportation.
|
Package vmess contains the implementation of VMess protocol and transportation. |
|
testing
|
|
|
mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
internet/kcp
Package kcp - A Fast and Reliable ARQ Protocol Acknowledgement: skywind3000@github for inventing the KCP protocol xtaci@github for translating to Golang
|
Package kcp - A Fast and Reliable ARQ Protocol Acknowledgement: skywind3000@github for inventing the KCP protocol xtaci@github for translating to Golang |
|
internet/websocket
Package websocket implements WebSocket transport WebSocket transport implements an HTTP(S) compliable, surveillance proof transport method with plausible deniability.
|
Package websocket implements WebSocket transport WebSocket transport implements an HTTP(S) compliable, surveillance proof transport method with plausible deniability. |
Click to show internal directories.
Click to hide internal directories.