github.com/xraypb/xray-core@v1.6.6/README.md (about) 1 # Project X 2 3 [Project X](https://github.com/XTLS) originates from XTLS protocol, provides a set of network tools such as [Xray-core](https://github.com/xraypb/xray-core). 4 5 ## License 6 7 [Mozilla Public License Version 2.0](https://github.com/xraypb/xray-core/blob/main/LICENSE) 8 9 ## Installation 10 11 - Linux Script 12 - [Xray-install](https://github.com/XTLS/Xray-install) 13 - [Xray-script](https://github.com/kirin10000/Xray-script) 14 - Docker 15 - [teddysun/xray](https://hub.docker.com/r/teddysun/xray) 16 - One Click 17 - [ProxySU](https://github.com/proxysu/ProxySU) 18 - [v2ray-agent](https://github.com/mack-a/v2ray-agent) 19 - [Xray-yes](https://github.com/jiuqi9997/Xray-yes) 20 - [Xray_onekey](https://github.com/wulabing/Xray_onekey) 21 - Magisk 22 - [Xray4Magisk](https://github.com/CerteKim/Xray4Magisk) 23 - [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk) 24 - Homebrew 25 - `brew install xray` 26 - [(Tap) Repository 0](https://github.com/N4FA/homebrew-xray) 27 - [(Tap) Repository 1](https://github.com/xiruizhao/homebrew-xray) 28 29 ## Contributing 30 [Code Of Conduct](https://github.com/xraypb/xray-core/blob/main/CODE_OF_CONDUCT.md) 31 32 ## Usage 33 34 [Xray-examples](https://github.com/XTLS/Xray-examples) / [VLESS-TCP-XTLS-WHATEVER](https://github.com/XTLS/Xray-examples/tree/main/VLESS-TCP-XTLS-WHATEVER) 35 36 ## GUI Clients 37 38 - OpenWrt 39 - [PassWall](https://github.com/xiaorouji/openwrt-passwall) 40 - [Hello World](https://github.com/jerrykuku/luci-app-vssr) 41 - [ShadowSocksR Plus+](https://github.com/fw876/helloworld) 42 - [luci-app-xray](https://github.com/yichya/luci-app-xray) ([openwrt-xray](https://github.com/yichya/openwrt-xray)) 43 - Windows 44 - [v2rayN](https://github.com/2dust/v2rayN) 45 - [Qv2ray](https://github.com/Qv2ray/Qv2ray) (This project had been archived and currently inactive) 46 - [Netch (NetFilter & TUN/TAP)](https://github.com/NetchX/Netch) (This project had been archived and currently inactive) 47 - Android 48 - [v2rayNG](https://github.com/2dust/v2rayNG) 49 - [Kitsunebi](https://github.com/rurirei/Kitsunebi/tree/release_xtls) 50 - iOS & macOS (with M1 chip) 51 - [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118) 52 - [Stash](https://apps.apple.com/app/stash/id1596063349) 53 - macOS (Intel chip & M1 chip) 54 - [Qv2ray](https://github.com/Qv2ray/Qv2ray) (This project had been archived and currently inactive) 55 - [V2RayXS](https://github.com/tzmax/V2RayXS) 56 57 ## Credits 58 59 This repo relies on the following third-party projects: 60 61 - Special thanks: 62 - [v2fly/v2ray-core](https://github.com/v2fly/v2ray-core) 63 - In production: 64 - [ghodss/yaml](https://github.com/ghodss/yaml) 65 - [gorilla/websocket](https://github.com/xraypb/websocket-1) 66 - [lucas-clemente/quic-go](https://github.com/lucas-clemente/quic-go) 67 - [pelletier/go-toml](https://github.com/pelletier/go-toml) 68 - [pires/go-proxyproto](https://github.com/pires/go-proxyproto) 69 - [refraction-networking/utls](https://github.com/refraction-networking/utls) 70 - [seiflotfy/cuckoofilter](https://github.com/seiflotfy/cuckoofilter) 71 - [google/starlark-go](https://github.com/google/starlark-go) 72 - For testing only: 73 - [miekg/dns](https://github.com/miekg/dns) 74 - [stretchr/testify](https://github.com/stretchr/testify) 75 - [h12w/socks](https://github.com/h12w/socks) 76 77 ## Compilation 78 79 ### Windows 80 81 ```bash 82 go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main 83 ``` 84 85 ### Linux / macOS 86 87 ```bash 88 go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main 89 ``` 90 91 ## Telegram 92 93 [Project X](https://t.me/projectXray) 94 95 [Project X Channel](https://t.me/projectXtls) 96 97 ## Stargazers over time 98 99 [![Stargazers over time](https://starchart.cc/XTLS/Xray-core.svg)](https://starchart.cc/XTLS/Xray-core)