github.com/xtls/xray-core@v1.8.12-0.20240518155711-3168d27b0bdb/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) (**Official**)
    25    - [tempest](https://github.com/team-cloudchaser/tempest) (supports [`systemd`](https://systemd.io) and [OpenRC](https://github.com/OpenRC/openrc); Linux-only)
    26  - Docker
    27    - [ghcr.io/xtls/xray-core](https://ghcr.io/xtls/xray-core) (**Official**)
    28    - [teddysun/xray](https://hub.docker.com/r/teddysun/xray)
    29  - Web Panel
    30    - [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)
    31    - [Xray-UI](https://github.com/qist/xray-ui), [X-UI](https://github.com/sing-web/x-ui)
    32    - [Hiddify](https://github.com/hiddify/hiddify-config)
    33    - [Marzban](https://github.com/Gozargah/Marzban)
    34    - [Libertea](https://github.com/VZiChoushaDui/Libertea)
    35  - One Click
    36    - [Xray-REALITY](https://github.com/zxcvos/Xray-script), [xray-reality](https://github.com/sajjaddg/xray-reality), [reality-ezpz](https://github.com/aleskxyz/reality-ezpz)
    37    - [Xray_bash_onekey](https://github.com/hello-yunshu/Xray_bash_onekey), [XTool](https://github.com/LordPenguin666/XTool)
    38    - [v2ray-agent](https://github.com/mack-a/v2ray-agent), [Xray_onekey](https://github.com/wulabing/Xray_onekey), [ProxySU](https://github.com/proxysu/ProxySU)
    39  - Magisk
    40    - [Xray4Magisk](https://github.com/Asterisk4Magisk/Xray4Magisk)
    41    - [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk)
    42  - Homebrew
    43    - `brew install xray`
    44  
    45  ## Usage
    46  
    47  - Example
    48    - [VLESS-XTLS-uTLS-REALITY](https://github.com/XTLS/REALITY#readme)
    49    - [VLESS-TCP-XTLS-Vision](https://github.com/XTLS/Xray-examples/tree/main/VLESS-TCP-XTLS-Vision)
    50    - [All-in-One-fallbacks-Nginx](https://github.com/XTLS/Xray-examples/tree/main/All-in-One-fallbacks-Nginx)
    51  - Xray-examples
    52    - [XTLS/Xray-examples](https://github.com/XTLS/Xray-examples)
    53    - [chika0801/Xray-examples](https://github.com/chika0801/Xray-examples)
    54    - [lxhao61/integrated-examples](https://github.com/lxhao61/integrated-examples)
    55  - Tutorial
    56    - [XTLS Vision](https://github.com/chika0801/Xray-install)
    57    - [REALITY (English)](https://cscot.pages.dev/2023/03/02/Xray-REALITY-tutorial/)
    58    - [XTLS-Iran-Reality (English)](https://github.com/SasukeFreestyle/XTLS-Iran-Reality)
    59    - [Xray REALITY with 'steal oneself' (English)](https://computerscot.github.io/vless-xtls-utls-reality-steal-oneself.html)
    60    - [Xray with WireGuard inbound (English)](https://g800.pages.dev/wireguard)
    61  
    62  ## GUI Clients
    63  
    64  - OpenWrt
    65    - [PassWall](https://github.com/xiaorouji/openwrt-passwall), [PassWall 2](https://github.com/xiaorouji/openwrt-passwall2)
    66    - [ShadowSocksR Plus+](https://github.com/fw876/helloworld)
    67    - [luci-app-xray](https://github.com/yichya/luci-app-xray) ([openwrt-xray](https://github.com/yichya/openwrt-xray))
    68  - Windows
    69    - [v2rayN](https://github.com/2dust/v2rayN)
    70    - [NekoRay](https://github.com/Matsuridayo/nekoray)
    71    - [Furious](https://github.com/LorenEteval/Furious)
    72    - [HiddifyN](https://github.com/hiddify/HiddifyN)
    73    - [Invisible Man - Xray](https://github.com/InvisibleManVPN/InvisibleMan-XRayClient)
    74  - Android
    75    - [v2rayNG](https://github.com/2dust/v2rayNG)
    76    - [HiddifyNG](https://github.com/hiddify/HiddifyNG)
    77    - [X-flutter](https://github.com/XTLS/X-flutter)
    78  - iOS & macOS arm64
    79    - [FoXray](https://apps.apple.com/app/foxray/id6448898396)
    80    - [Streisand](https://apps.apple.com/app/streisand/id6450534064)
    81  - macOS arm64 & x64
    82    - [V2rayU](https://github.com/yanue/V2rayU)
    83    - [V2RayXS](https://github.com/tzmax/V2RayXS)
    84    - [Furious](https://github.com/LorenEteval/Furious)
    85    - [FoXray](https://apps.apple.com/app/foxray/id6448898396)
    86  - Linux
    87    - [v2rayA](https://github.com/v2rayA/v2rayA)
    88    - [NekoRay](https://github.com/Matsuridayo/nekoray)
    89    - [Furious](https://github.com/LorenEteval/Furious)
    90  
    91  ## Others that support VLESS, XTLS, REALITY, XUDP, PLUX...
    92  
    93  - iOS & macOS arm64
    94    - [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118)
    95  - Xray Tools
    96    - [xray-knife](https://github.com/lilendian0x00/xray-knife)
    97  - Xray Wrapper
    98    - [XTLS/libXray](https://github.com/XTLS/libXray)
    99    - [xtlsapi](https://github.com/hiddify/xtlsapi)
   100    - [AndroidLibXrayLite](https://github.com/2dust/AndroidLibXrayLite)
   101    - [XrayKit](https://github.com/arror/XrayKit)
   102    - [Xray-core-python](https://github.com/LorenEteval/Xray-core-python)
   103    - [xray-api](https://github.com/XVGuardian/xray-api)
   104  - [XrayR](https://github.com/XrayR-project/XrayR)
   105    - [XrayR-release](https://github.com/XrayR-project/XrayR-release)
   106    - [XrayR-V2Board](https://github.com/missuo/XrayR-V2Board)
   107  - [Clash.Meta](https://github.com/MetaCubeX/Clash.Meta)
   108    - [Clash Verge](https://github.com/zzzgydi/clash-verge)
   109    - [clashN](https://github.com/2dust/clashN)
   110    - [Clash Meta for Android](https://github.com/MetaCubeX/ClashMetaForAndroid)
   111    - [meta_for_ios](https://t.me/meta_for_ios)
   112  - [sing-box](https://github.com/SagerNet/sing-box)
   113    - [installReality](https://github.com/BoxXt/installReality)
   114    - [sbox-reality](https://github.com/Misaka-blog/sbox-reality)
   115    - [sing-box-for-ios](https://github.com/SagerNet/sing-box-for-ios)
   116  
   117  ## Contributing
   118  
   119  [Code of Conduct](https://github.com/XTLS/Xray-core/blob/main/CODE_OF_CONDUCT.md)
   120  
   121  ## Credits
   122  
   123  - [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).
   124  - 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).
   125  
   126  ## Compilation
   127  
   128  ### Windows (PowerShell)
   129  
   130  ```powershell
   131  $env:CGO_ENABLED=0
   132  go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main
   133  ```
   134  
   135  ### Linux / macOS
   136  
   137  ```bash
   138  CGO_ENABLED=0 go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main
   139  ```
   140  
   141  ### Reproducible Releases
   142  
   143  ```bash
   144  make
   145  ```
   146  
   147  ## Stargazers over time
   148  
   149  [![Stargazers over time](https://starchart.cc/XTLS/Xray-core.svg)](https://starchart.cc/XTLS/Xray-core)