github.com/xtls/xray-core@v1.8.3/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/XTLS/Xray-core) and [REALITY](https://github.com/XTLS/REALITY). 4 5 [README](https://github.com/XTLS/Xray-core#readme) is open, so feel free to submit your project [here](https://github.com/XTLS/Xray-core/pulls). 6 7 ## License 8 9 [Mozilla Public License Version 2.0](https://github.com/XTLS/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 - [Xray-UI](https://github.com/qist/xray-ui), [X-UI](https://github.com/sing-web/x-ui) 30 - [Hiddify](https://github.com/hiddify/hiddify-config) 31 - [Marzban](https://github.com/Gozargah/Marzban) 32 - [Libertea](https://github.com/VZiChoushaDui/Libertea) 33 - One Click 34 - [Xray-REALITY](https://github.com/zxcvos/Xray-script), [xray-reality](https://github.com/sajjaddg/xray-reality), [reality-ezpz](https://github.com/aleskxyz/reality-ezpz) 35 - [Xray-script](https://github.com/kirin10000/Xray-script), [Xray_bash_onekey](https://github.com/hello-yunshu/Xray_bash_onekey), [XTool](https://github.com/LordPenguin666/XTool) 36 - [v2ray-agent](https://github.com/mack-a/v2ray-agent), [Xray_onekey](https://github.com/wulabing/Xray_onekey), [ProxySU](https://github.com/proxysu/ProxySU) 37 - Magisk 38 - [Xray4Magisk](https://github.com/Asterisk4Magisk/Xray4Magisk) 39 - [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk) 40 - Homebrew 41 - `brew install xray` 42 43 ## Usage 44 45 - Example 46 - [VLESS-XTLS-uTLS-REALITY](https://github.com/XTLS/REALITY#readme) 47 - [VLESS-TCP-XTLS-Vision](https://github.com/XTLS/Xray-examples/tree/main/VLESS-TCP-XTLS-Vision) 48 - [All-in-One-fallbacks-Nginx](https://github.com/XTLS/Xray-examples/tree/main/All-in-One-fallbacks-Nginx) 49 - Xray-examples 50 - [XTLS/Xray-examples](https://github.com/XTLS/Xray-examples) 51 - [chika0801/Xray-examples](https://github.com/chika0801/Xray-examples) 52 - [lxhao61/integrated-examples](https://github.com/lxhao61/integrated-examples) 53 - Tutorial 54 - [XTLS Vision](https://github.com/chika0801/Xray-install) 55 - [REALITY (English)](https://cscot.pages.dev/2023/03/02/Xray-REALITY-tutorial/) 56 - [XTLS-Iran-Reality (English)](https://github.com/SasukeFreestyle/XTLS-Iran-Reality) 57 58 ## GUI Clients 59 60 - OpenWrt 61 - [PassWall](https://github.com/xiaorouji/openwrt-passwall), [PassWall 2](https://github.com/xiaorouji/openwrt-passwall2) 62 - [ShadowSocksR Plus+](https://github.com/fw876/helloworld) 63 - [luci-app-xray](https://github.com/yichya/luci-app-xray) ([openwrt-xray](https://github.com/yichya/openwrt-xray)) 64 - Windows 65 - [v2rayN](https://github.com/2dust/v2rayN) 66 - [HiddifyN](https://github.com/hiddify/HiddifyN) 67 - [Invisible Man - Xray](https://github.com/InvisibleManVPN/InvisibleMan-XRayClient) 68 - Android 69 - [v2rayNG](https://github.com/2dust/v2rayNG) 70 - [HiddifyNG](https://github.com/hiddify/HiddifyNG) 71 - [X-flutter](https://github.com/XTLS/X-flutter) 72 - iOS & macOS arm64 73 - [Mango](https://github.com/arror/Mango) 74 - [FoXray](https://apps.apple.com/app/foxray/id6448898396) 75 - macOS arm64 & x64 76 - [V2RayXS](https://github.com/tzmax/V2RayXS) 77 - [FoXray](https://apps.apple.com/app/foxray/id6448898396) 78 - Linux 79 - [v2rayA](https://github.com/v2rayA/v2rayA) 80 81 ## Others that support VLESS, XTLS, REALITY, XUDP, PLUX... 82 83 - iOS & macOS arm64 84 - [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118) 85 - Xray Wrapper 86 - [XTLS/libXray](https://github.com/XTLS/libXray) 87 - [xtlsapi](https://github.com/hiddify/xtlsapi) 88 - [AndroidLibXrayLite](https://github.com/2dust/AndroidLibXrayLite) 89 - [XrayKit](https://github.com/arror/XrayKit) 90 - [XrayR](https://github.com/XrayR-project/XrayR) 91 - [XrayR-release](https://github.com/XrayR-project/XrayR-release) 92 - [XrayR-V2Board](https://github.com/missuo/XrayR-V2Board) 93 - [Clash.Meta](https://github.com/MetaCubeX/Clash.Meta) 94 - [Clash Verge](https://github.com/zzzgydi/clash-verge) 95 - [clashN](https://github.com/2dust/clashN) 96 - [Clash Meta for Android](https://github.com/MetaCubeX/ClashMetaForAndroid) 97 - [meta_for_ios](https://t.me/meta_for_ios) 98 - [sing-box](https://github.com/SagerNet/sing-box) 99 - [installReality](https://github.com/BoxXt/installReality) 100 - [sbox-reality](https://github.com/Misaka-blog/sbox-reality) 101 - [sing-box-for-ios](https://github.com/SagerNet/sing-box-for-ios) 102 103 ## Contributing 104 105 [Code of Conduct](https://github.com/XTLS/Xray-core/blob/main/CODE_OF_CONDUCT.md) 106 107 ## Credits 108 109 - [Xray-core v1.0.0](https://github.com/XTLS/Xray-core/releases/tag/v1.0.0) was forked from [v2fly-core 9a03cc5](https://github.com/v2fly/v2ray-core/commit/9a03cc5c98d04cc28320fcee26dbc236b3291256), and we have made & accumulated a huge number of enhancements over time, check [the release notes for each version](https://github.com/XTLS/Xray-core/releases). 110 - For third-party projects used in [Xray-core](https://github.com/XTLS/Xray-core), check your local or [the latest go.mod](https://github.com/XTLS/Xray-core/blob/main/go.mod). 111 112 ## Compilation 113 114 ### Windows 115 116 ```bash 117 go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main 118 ``` 119 120 ### Linux / macOS 121 122 ```bash 123 go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main 124 ``` 125 126 ## Stargazers over time 127 128 [](https://starchart.cc/XTLS/Xray-core)