github.com/moqsien/xraycore@v1.8.5/README.md (about)

     1  # Project X
     2  
     3  ## Notice
     4  **This is a fork from [xray-core](https://github.com/moqsien/Xray-core) which is independently maintained for Neobox with later versions of wiregaurd-go adopted.**
     5  **本项目仅仅是xray-core项目的一个独立fork，主要用于引入较新版的wireguard-go，以便在Neobox中同时使用xray-core和最新的sing-box。**
     6  **Thanks to the xray-core developers/maintainers.**
     7  
     8  [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).
     9  
    10  [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).
    11  
    12  ## License
    13  
    14  [Mozilla Public License Version 2.0](https://github.com/XTLS/Xray-core/blob/main/LICENSE)
    15  
    16  ## Documentation
    17  
    18  [Project X Official Website](https://xtls.github.io)
    19  
    20  ## Telegram
    21  
    22  [Project X](https://t.me/projectXray)
    23  
    24  [Project X Channel](https://t.me/projectXtls)
    25  
    26  ## Installation
    27  
    28  - Linux Script
    29    - [XTLS/Xray-install](https://github.com/XTLS/Xray-install)
    30  - Docker
    31    - [iamybj/docker-xray](https://hub.docker.com/r/iamybj/docker-xray)
    32    - [teddysun/xray](https://hub.docker.com/r/teddysun/xray)
    33  - Web Panel
    34    - [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)
    35    - [Xray-UI](https://github.com/qist/xray-ui), [X-UI](https://github.com/sing-web/x-ui)
    36    - [Hiddify](https://github.com/hiddify/hiddify-config)
    37    - [Marzban](https://github.com/Gozargah/Marzban)
    38    - [Libertea](https://github.com/VZiChoushaDui/Libertea)
    39  - One Click
    40    - [Xray-REALITY](https://github.com/zxcvos/Xray-script), [xray-reality](https://github.com/sajjaddg/xray-reality), [reality-ezpz](https://github.com/aleskxyz/reality-ezpz)
    41    - [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)
    42    - [v2ray-agent](https://github.com/mack-a/v2ray-agent), [Xray_onekey](https://github.com/wulabing/Xray_onekey), [ProxySU](https://github.com/proxysu/ProxySU)
    43  - Magisk
    44    - [Xray4Magisk](https://github.com/Asterisk4Magisk/Xray4Magisk)
    45    - [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk)
    46  - Homebrew
    47    - `brew install xray`
    48  
    49  ## Usage
    50  
    51  - Example
    52    - [VLESS-XTLS-uTLS-REALITY](https://github.com/XTLS/REALITY#readme)
    53    - [VLESS-TCP-XTLS-Vision](https://github.com/XTLS/Xray-examples/tree/main/VLESS-TCP-XTLS-Vision)
    54    - [All-in-One-fallbacks-Nginx](https://github.com/XTLS/Xray-examples/tree/main/All-in-One-fallbacks-Nginx)
    55  - Xray-examples
    56    - [XTLS/Xray-examples](https://github.com/XTLS/Xray-examples)
    57    - [chika0801/Xray-examples](https://github.com/chika0801/Xray-examples)
    58    - [lxhao61/integrated-examples](https://github.com/lxhao61/integrated-examples)
    59  - Tutorial
    60    - [XTLS Vision](https://github.com/chika0801/Xray-install)
    61    - [REALITY (English)](https://cscot.pages.dev/2023/03/02/Xray-REALITY-tutorial/)
    62    - [XTLS-Iran-Reality (English)](https://github.com/SasukeFreestyle/XTLS-Iran-Reality)
    63    - [Xray REALITY with 'steal oneself' (English)](https://computerscot.github.io/vless-xtls-utls-reality-steal-oneself.html)
    64  
    65  ## GUI Clients
    66  
    67  - OpenWrt
    68    - [PassWall](https://github.com/xiaorouji/openwrt-passwall), [PassWall 2](https://github.com/xiaorouji/openwrt-passwall2)
    69    - [ShadowSocksR Plus+](https://github.com/fw876/helloworld)
    70    - [luci-app-xray](https://github.com/yichya/luci-app-xray) ([openwrt-xray](https://github.com/yichya/openwrt-xray))
    71  - Windows
    72    - [v2rayN](https://github.com/2dust/v2rayN)
    73    - [NekoRay](https://github.com/Matsuridayo/nekoray)
    74    - [Furious](https://github.com/LorenEteval/Furious)
    75    - [HiddifyN](https://github.com/hiddify/HiddifyN)
    76    - [Invisible Man - Xray](https://github.com/InvisibleManVPN/InvisibleMan-XRayClient)
    77  - Android
    78    - [v2rayNG](https://github.com/2dust/v2rayNG)
    79    - [HiddifyNG](https://github.com/hiddify/HiddifyNG)
    80    - [X-flutter](https://github.com/XTLS/X-flutter)
    81  - iOS & macOS arm64
    82    - [Mango](https://github.com/arror/Mango)
    83    - [FoXray](https://apps.apple.com/app/foxray/id6448898396)
    84  - macOS arm64 & x64
    85    - [V2rayU](https://github.com/yanue/V2rayU)
    86    - [V2RayXS](https://github.com/tzmax/V2RayXS)
    87    - [Furious](https://github.com/LorenEteval/Furious)
    88    - [FoXray](https://apps.apple.com/app/foxray/id6448898396)
    89  - Linux
    90    - [v2rayA](https://github.com/v2rayA/v2rayA)
    91    - [NekoRay](https://github.com/Matsuridayo/nekoray)
    92    - [Furious](https://github.com/LorenEteval/Furious)
    93  
    94  ## Others that support VLESS, XTLS, REALITY, XUDP, PLUX...
    95  
    96  - iOS & macOS arm64
    97    - [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118)
    98  - Xray Wrapper
    99    - [XTLS/libXray](https://github.com/XTLS/libXray)
   100    - [xtlsapi](https://github.com/hiddify/xtlsapi)
   101    - [AndroidLibXrayLite](https://github.com/2dust/AndroidLibXrayLite)
   102    - [XrayKit](https://github.com/arror/XrayKit)
   103    - [Xray-core-python](https://github.com/LorenEteval/Xray-core-python)
   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
   129  
   130  ```bash
   131  go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main
   132  ```
   133  
   134  ### Linux / macOS
   135  
   136  ```bash
   137  go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main
   138  ```
   139  
   140  ## Stargazers over time
   141  
   142  [![Stargazers over time](https://starchart.cc/XTLS/Xray-core.svg)](https://starchart.cc/XTLS/Xray-core)