mirror of https://github.com/XTLS/Xray-core
				
				
				
			| 
				
					
						
							 | 
			||
|---|---|---|
| .github | ||
| app | ||
| common | ||
| core | ||
| features | ||
| infra | ||
| main | ||
| proxy | ||
| testing | ||
| transport | ||
| .gitignore | ||
| CODE_OF_CONDUCT.md | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| go.mod | ||
| go.sum | ||
		
			
				
				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.
License
Mozilla Public License Version 2.0
Documentation
Telegram
Installation
- Linux Script
- XTLS/Xray-install (Official)
 - tempest (supports 
systemdand OpenRC; Linux-only) 
 - Docker
- ghcr.io/xtls/xray-core (Official)
 - teddysun/xray
 
 - Web Panel
 - One Click
 - Magisk
 - Homebrew
brew install xray
 
Usage
- Example
 - Xray-examples
 - Tutorial
 
GUI Clients
- OpenWrt
 - Windows
 - Android
 - iOS & macOS arm64
 - macOS arm64 & x64
 - Linux
 
Others that support VLESS, XTLS, REALITY, XUDP, PLUX...
- iOS & macOS arm64
 - Xray Tools
 - Xray Wrapper
 - XrayR
 - Clash.Meta
 - sing-box
 
Contributing
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