github.com/xraypb/Xray-core@v1.8.1/README.md (about) 1 # Project X 2 3 [Project X](https://github.com/XTLS) originates from XTLS protocol, providing a set of network tools such as [Xray-core](https://github.com/xraypb/Xray-core) and [REALITY](https://github.com/XTLS/REALITY). 4 5 [README](https://github.com/xraypb/Xray-core#readme) is open, so feel free to submit your project [here](https://github.com/xraypb/Xray-core/pulls). 6 7 ## License 8 9 [Mozilla Public License Version 2.0](https://github.com/xraypb/Xray-core/blob/main/LICENSE) 10 11 ## Documentation 12 13 [Project X Official Website](https://xtls.github.io) 14 15 ## Telegram 16 17 [Project X](https://t.me/projectXray) 18 19 [Project X Channel](https://t.me/projectXtls) 20 21 ## Installation 22 23 - Linux Script 24 - [XTLS/Xray-install](https://github.com/XTLS/Xray-install) 25 - Docker 26 - [teddysun/xray](https://hub.docker.com/r/teddysun/xray) 27 - Web Panel 28 - [X-UI](https://github.com/FranzKafkaYu/x-ui), [X-UI-English](https://github.com/NidukaAkalanka/x-ui-english), [3X-UI](https://github.com/MHSanaei/3x-ui), [X-UI](https://github.com/alireza0/x-ui), [X-UI](https://github.com/diditra/x-ui) 29 - [Hiddify](https://github.com/hiddify/hiddify-config) 30 - [Marzban](https://github.com/Gozargah/Marzban) 31 - One Click 32 - [Xray-script](https://github.com/kirin10000/Xray-script), [Xray-script](https://github.com/zxcvos/Xray-script), [xray_script](https://github.com/tdjnodj/xray_script) 33 - [XTool](https://github.com/LordPenguin666/XTool), [Xray_bash_onekey](https://github.com/hello-yunshu/Xray_bash_onekey), [xray-reality](https://github.com/sajjaddg/xray-reality) 34 - [v2ray-agent](https://github.com/mack-a/v2ray-agent), [Xray_onekey](https://github.com/wulabing/Xray_onekey), [ProxySU](https://github.com/proxysu/ProxySU) 35 - Magisk 36 - [Xray4Magisk](https://github.com/CerteKim/Xray4Magisk) 37 - [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk) 38 - Homebrew 39 - `brew install xray` 40 - [(Tap) Repository 0](https://github.com/N4FA/homebrew-xray) 41 42 ## Usage 43 44 - Example 45 - [VLESS-XTLS-uTLS-REALITY](https://github.com/XTLS/REALITY#readme) 46 - [VLESS-TCP-XTLS-Vision](https://github.com/XTLS/Xray-examples/tree/main/VLESS-TCP-XTLS-Vision) 47 - [All-in-One-fallbacks-Nginx](https://github.com/XTLS/Xray-examples/tree/main/All-in-One-fallbacks-Nginx) 48 - Xray-examples 49 - [XTLS/Xray-examples](https://github.com/XTLS/Xray-examples) 50 - [chika0801/Xray-examples](https://github.com/chika0801/Xray-examples) 51 - [lxhao61/integrated-examples](https://github.com/lxhao61/integrated-examples) 52 - Tutorial 53 - [XTLS Vision](https://github.com/chika0801/Xray-install) 54 - [REALITY (English)](https://cscot.pages.dev/2023/03/02/Xray-REALITY-tutorial/) 55 56 ## GUI Clients 57 58 - OpenWrt 59 - [PassWall](https://github.com/xiaorouji/openwrt-passwall), [PassWall 2](https://github.com/xiaorouji/openwrt-passwall2) 60 - [ShadowSocksR Plus+](https://github.com/fw876/helloworld) 61 - [luci-app-xray](https://github.com/yichya/luci-app-xray) ([openwrt-xray](https://github.com/yichya/openwrt-xray)) 62 - Windows 63 - [v2rayN](https://github.com/2dust/v2rayN) 64 - [Invisible Man - Xray](https://github.com/InvisibleManVPN/InvisibleMan-XRayClient) 65 - Android 66 - [v2rayNG](https://github.com/2dust/v2rayNG) 67 - [X-flutter](https://github.com/XTLS/X-flutter) 68 - iOS & macOS arm64 69 - [Mango](https://github.com/daemooon/Mango) 70 - [Wings X](https://apps.apple.com/app/wings-x/id6446119727) 71 - macOS arm64 & x64 72 - [V2RayXS](https://github.com/tzmax/V2RayXS) 73 - [Wings X](https://apps.apple.com/app/wings-x/id6446119727) 74 75 ## Others that support VLESS, XTLS, REALITY, XUDP, PLUX... 76 77 - iOS & macOS arm64 78 - [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118) 79 - [Stash](https://apps.apple.com/app/stash/id1596063349) 80 - API Wrapper 81 - [xtlsapi](https://github.com/hiddify/xtlsapi) 82 - [XrayR](https://github.com/XrayR-project/XrayR) 83 - [XrayR-release](https://github.com/XrayR-project/XrayR-release) 84 - [XrayR-V2Board](https://github.com/missuo/XrayR-V2Board) 85 - [Clash.Meta](https://github.com/MetaCubeX/Clash.Meta) 86 - [Clash Verge](https://github.com/zzzgydi/clash-verge) 87 - [clashN](https://github.com/2dust/clashN) 88 - [Clash Meta for Android](https://github.com/MetaCubeX/ClashMetaForAndroid) 89 - [meta_for_ios](https://t.me/meta_for_ios) 90 - [sing-box](https://github.com/SagerNet/sing-box) 91 - [installReality](https://github.com/BoxXt/installReality) 92 - [sing-box-for-ios](https://github.com/SagerNet/sing-box-for-ios) 93 94 ## Contributing 95 96 [Code of Conduct](https://github.com/xraypb/Xray-core/blob/main/CODE_OF_CONDUCT.md) 97 98 ## Credits 99 100 This repo relies on the following third-party projects: 101 102 - Special thanks: 103 - [v2fly/v2ray-core](https://github.com/v2fly/v2ray-core) 104 - In production: 105 - [ghodss/yaml](https://github.com/ghodss/yaml) 106 - [gorilla/websocket](https://github.com/djoeni/websocket) 107 - [quic-go/quic-go](https://github.com/quic-go/quic-go) 108 - [pelletier/go-toml](https://github.com/pelletier/go-toml) 109 - [pires/go-proxyproto](https://github.com/pires/go-proxyproto) 110 - [refraction-networking/utls](https://github.com/refraction-networking/utls) 111 - [seiflotfy/cuckoofilter](https://github.com/seiflotfy/cuckoofilter) 112 - [google/starlark-go](https://github.com/google/starlark-go) 113 - For testing only: 114 - [miekg/dns](https://github.com/miekg/dns) 115 - [stretchr/testify](https://github.com/stretchr/testify) 116 - [h12w/socks](https://github.com/h12w/socks) 117 118 ## Compilation 119 120 ### Windows 121 122 ```bash 123 go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main 124 ``` 125 126 ### Linux / macOS 127 128 ```bash 129 go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main 130 ``` 131 132 ## Stargazers over time 133 134 [](https://starchart.cc/XTLS/Xray-core)