# 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.
License
Mozilla Public License Version 2.0
Documentation
Telegram
Installation
- Linux Script
- Docker
- Web Panel
- One Click
- Magisk
- Homebrew
brew install xray
- (Tap) Repository 0
Usage
- Example
- Xray-examples
- Tutorial
GUI Clients
- OpenWrt
- Windows
- Android
- iOS & macOS arm64
- macOS arm64 & x64
Others that support VLESS, XTLS, REALITY, XUDP, PLUX...
- iOS & macOS arm64
- API Wrapper
- XrayR
- Clash.Meta
- sing-box
Contributing
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
Stargazers over time
# Packages
Package app contains feature implementations of Xray.
Package common contains common utilities that are shared among other packages.
Package core provides an entry point to use Xray core functionalities.
No description provided by the author
No description provided by the author
No description provided by the author
Package proxy contains all proxies used by Xray.
No description provided by the author
No description provided by the author