Xray-core/README.md

Project X

Project X originates from XTLS protocol, provides a set of network tools such as Xray-core.

License

Mozilla Public License Version 2.0

Installation

• Linux Script
  • Xray-install
  • Xray-script
• Docker
  • teddysun/xray
• One Click
  • ProxySU
  • v2ray-agent
  • Xray-yes
  • Xray_onekey
• Magisk
  • Xray4Magisk
  • Xray_For_Magisk
• Homebrew
  • brew install xray
  • (Tap) Repository 0
  • (Tap) Repository 1

Contributing

Code Of Conduct

Usage

Xray-examples / VLESS-TCP-XTLS-WHATEVER

GUI Clients

• OpenWrt
  • PassWall
  • Hello World
  • ShadowSocksR Plus+
  • luci-app-xray (openwrt-xray)
• Windows
  • v2rayN
  • Qv2ray (This project had been archived and currently inactive)
  • Netch (NetFilter & TUN/TAP) (This project had been archived and currently inactive)
• Android
  • v2rayNG
  • Kitsunebi
• iOS & macOS (with M1 chip)
  • Shadowrocket
  • Stash
• macOS (Intel chip & M1 chip)
  • Qv2ray (This project had been archived and currently inactive)
  • V2RayXS

Credits

This repo relies on the following third-party projects:

• Special thanks:
  • v2fly/v2ray-core
• In production:
  • ghodss/yaml
  • gorilla/websocket
  • quic-go/quic-go
  • pelletier/go-toml
  • pires/go-proxyproto
  • refraction-networking/utls
  • seiflotfy/cuckoofilter
  • google/starlark-go
• For testing only:
  • miekg/dns
  • stretchr/testify
  • h12w/socks

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

Project X

Project X Channel

Stargazers over time