github.com/eagleql/xray-core@v1.4.4/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/eagleql/xray-core) and [Xray-flutter](https://github.com/XTLS/Xray-flutter).
     4  
     5  ## License
     6  
     7  [Mozilla Public License Version 2.0](https://github.com/eagleql/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    - Xray-docker
    17  - One Click
    18    - [ProxySU](https://github.com/proxysu/ProxySU)
    19    - [v2ray-agent](https://github.com/mack-a/v2ray-agent)
    20    - [Xray-yes](https://github.com/jiuqi9997/Xray-yes)
    21    - [Xray_onekey](https://github.com/wulabing/Xray_onekey)
    22  - Magisk
    23    - [Xray4Magisk](https://github.com/CerteKim/Xray4Magisk)
    24    - [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk)
    25  - Homebrew
    26    - `brew install xray`
    27    - [(Tap) Repository 0](https://github.com/N4FA/homebrew-xray)
    28    - [(Tap) Repository 1](https://github.com/xiruizhao/homebrew-xray)
    29  
    30  ## Usage
    31  
    32  [Xray-examples](https://github.com/XTLS/Xray-examples) / [VLESS-TCP-XTLS-WHATEVER](https://github.com/XTLS/Xray-examples/tree/main/VLESS-TCP-XTLS-WHATEVER)
    33  
    34  ## GUI Clients
    35  
    36  - OpenWrt
    37    - [PassWall](https://github.com/xiaorouji/openwrt-passwall)
    38    - [Hello World](https://github.com/jerrykuku/luci-app-vssr)
    39    - [ShadowSocksR Plus+](https://github.com/fw876/helloworld)
    40    - [luci-app-xray](https://github.com/yichya/luci-app-xray) ([openwrt-xray](https://github.com/yichya/openwrt-xray))
    41  - Windows
    42    - [v2rayN](https://github.com/2dust/v2rayN)
    43    - [Qv2ray](https://github.com/Qv2ray/Qv2ray)
    44    - [Netch (NetFilter & TUN/TAP)](https://github.com/NetchX/Netch)
    45  - Android
    46    - [v2rayNG](https://github.com/2dust/v2rayNG)
    47    - [AnXray](https://github.com/XTLS/AnXray)
    48    - [Kitsunebi](https://github.com/rurirei/Kitsunebi/tree/release_xtls)
    49  - iOS / Mac
    50    - [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118)
    51  
    52  ## Credits
    53  
    54  This repo relies on the following third-party projects:
    55  
    56  - Special thanks:
    57    - [v2fly/v2ray-core](https://github.com/v2fly/v2ray-core)
    58  - In production:
    59    - [gorilla/websocket](https://github.com/gorilla/websocket)
    60    - [lucas-clemente/quic-go](https://github.com/lucas-clemente/quic-go)
    61    - [pires/go-proxyproto](https://github.com/pires/go-proxyproto)
    62    - [seiflotfy/cuckoofilter](https://github.com/seiflotfy/cuckoofilter)
    63    - [google/starlark-go](https://github.com/google/starlark-go)
    64  - For testing only:
    65    - [miekg/dns](https://github.com/miekg/dns)
    66    - [h12w/socks](https://github.com/h12w/socks)
    67  
    68  ## Compilation
    69  
    70  ### Windows
    71  
    72  ```
    73  go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main
    74  ```
    75  
    76  ### Linux / macOS
    77  
    78  ```
    79  go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main
    80  ```
    81  
    82  ## Telegram
    83  
    84  [Project X](https://t.me/projectXray)
    85  
    86  [Project X Channel](https://t.me/projectXtls)
    87  
    88  ## Stargazers over time
    89  
    90  [![Stargazers over time](https://starchart.cc/eagleql/xray-core.svg)](https://starchart.cc/eagleql/xray-core)