Xray-core/README.md

145 lines
6.1 KiB
Markdown
Raw Normal View History

2020-11-25 11:01:53 +00:00
# Project X
[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).
[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).
2020-11-25 11:01:53 +00:00
2020-11-27 08:33:31 +00:00
## License
[Mozilla Public License Version 2.0](https://github.com/XTLS/Xray-core/blob/main/LICENSE)
## Documentation
[Project X Official Website](https://xtls.github.io)
## Telegram
[Project X](https://t.me/projectXray)
[Project X Channel](https://t.me/projectXtls)
2020-11-25 11:01:53 +00:00
## Installation
2020-11-27 03:08:28 +00:00
- Linux Script
- [XTLS/Xray-install](https://github.com/XTLS/Xray-install)
2020-11-25 12:27:18 +00:00
- Docker
- [teddysun/xray](https://hub.docker.com/r/teddysun/xray)
- Web Panel
- [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)
2023-04-17 23:21:56 +00:00
- [Xray-UI](https://github.com/qist/xray-ui), [X-UI](https://github.com/sing-web/x-ui)
- [Hiddify](https://github.com/hiddify/hiddify-config)
- [Marzban](https://github.com/Gozargah/Marzban)
2023-04-17 23:21:56 +00:00
- [Libertea](https://github.com/VZiChoushaDui/Libertea)
2020-11-27 03:08:28 +00:00
- One Click
2023-04-17 23:21:56 +00:00
- [Xray-script](https://github.com/kirin10000/Xray-script), [Xray-REALITY](https://github.com/zxcvos/Xray-script), [LetsXray](https://github.com/tdjnodj/LetsXray)
- [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)
- [v2ray-agent](https://github.com/mack-a/v2ray-agent), [Xray_onekey](https://github.com/wulabing/Xray_onekey), [ProxySU](https://github.com/proxysu/ProxySU)
2020-12-01 10:20:29 +00:00
- Magisk
2023-04-17 23:21:56 +00:00
- [Xray4Magisk](https://github.com/Asterisk4Magisk/Xray4Magisk)
2020-12-01 10:20:29 +00:00
- [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk)
2020-12-24 12:43:19 +00:00
- Homebrew
- `brew install xray`
2020-11-25 11:01:53 +00:00
## Usage
- Example
- [VLESS-XTLS-uTLS-REALITY](https://github.com/XTLS/REALITY#readme)
- [VLESS-TCP-XTLS-Vision](https://github.com/XTLS/Xray-examples/tree/main/VLESS-TCP-XTLS-Vision)
- [All-in-One-fallbacks-Nginx](https://github.com/XTLS/Xray-examples/tree/main/All-in-One-fallbacks-Nginx)
- Xray-examples
- [XTLS/Xray-examples](https://github.com/XTLS/Xray-examples)
- [chika0801/Xray-examples](https://github.com/chika0801/Xray-examples)
- [lxhao61/integrated-examples](https://github.com/lxhao61/integrated-examples)
- Tutorial
- [XTLS Vision](https://github.com/chika0801/Xray-install)
- [REALITY (English)](https://cscot.pages.dev/2023/03/02/Xray-REALITY-tutorial/)
2023-04-17 23:21:56 +00:00
- [XTLS-Iran-Reality (English)](https://github.com/SasukeFreestyle/XTLS-Iran-Reality)
2020-11-25 11:01:53 +00:00
2020-12-01 10:22:07 +00:00
## GUI Clients
- OpenWrt
- [PassWall](https://github.com/xiaorouji/openwrt-passwall), [PassWall 2](https://github.com/xiaorouji/openwrt-passwall2)
2020-12-13 05:55:38 +00:00
- [ShadowSocksR Plus+](https://github.com/fw876/helloworld)
2021-01-26 22:50:28 +00:00
- [luci-app-xray](https://github.com/yichya/luci-app-xray) ([openwrt-xray](https://github.com/yichya/openwrt-xray))
2020-12-01 10:22:07 +00:00
- Windows
- [v2rayN](https://github.com/2dust/v2rayN)
- [HiddifyN](https://github.com/hiddify/HiddifyN)
- [Invisible Man - Xray](https://github.com/InvisibleManVPN/InvisibleMan-XRayClient)
2020-12-01 10:22:07 +00:00
- Android
- [v2rayNG](https://github.com/2dust/v2rayNG)
- [HiddifyNG](https://github.com/hiddify/HiddifyNG)
- [X-flutter](https://github.com/XTLS/X-flutter)
- iOS & macOS arm64
2023-04-17 23:21:56 +00:00
- [Mango](https://github.com/arror/Mango)
- [Wings X](https://apps.apple.com/app/wings-x/id6446119727)
- macOS arm64 & x64
- [V2RayXS](https://github.com/tzmax/V2RayXS)
- [Wings X](https://apps.apple.com/app/wings-x/id6446119727)
- Linux
- [v2rayA](https://github.com/v2rayA/v2rayA)
## Others that support VLESS, XTLS, REALITY, XUDP, PLUX...
- iOS & macOS arm64
2020-12-01 10:22:07 +00:00
- [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118)
2022-06-11 05:02:52 +00:00
- [Stash](https://apps.apple.com/app/stash/id1596063349)
2023-04-17 23:21:56 +00:00
- Xray Wrapper
- [xtlsapi](https://github.com/hiddify/xtlsapi)
2023-04-17 23:21:56 +00:00
- [AndroidLibXrayLite](https://github.com/2dust/AndroidLibXrayLite)
- [XrayKit](https://github.com/arror/XrayKit)
- [libxray](https://github.com/KouYiGuo/libxray)
- [XrayR](https://github.com/XrayR-project/XrayR)
- [XrayR-release](https://github.com/XrayR-project/XrayR-release)
- [XrayR-V2Board](https://github.com/missuo/XrayR-V2Board)
- [Clash.Meta](https://github.com/MetaCubeX/Clash.Meta)
- [Clash Verge](https://github.com/zzzgydi/clash-verge)
- [clashN](https://github.com/2dust/clashN)
- [Clash Meta for Android](https://github.com/MetaCubeX/ClashMetaForAndroid)
- [meta_for_ios](https://t.me/meta_for_ios)
- [sing-box](https://github.com/SagerNet/sing-box)
- [installReality](https://github.com/BoxXt/installReality)
- [sbox-reality](https://github.com/Misaka-blog/sbox-reality)
- [sing-box-for-ios](https://github.com/SagerNet/sing-box-for-ios)
## Contributing
[Code of Conduct](https://github.com/XTLS/Xray-core/blob/main/CODE_OF_CONDUCT.md)
2020-12-01 10:22:07 +00:00
2020-11-25 11:01:53 +00:00
## Credits
This repo relies on the following third-party projects:
- Special thanks:
- [v2fly/v2ray-core](https://github.com/v2fly/v2ray-core)
- In production:
2022-04-09 04:48:02 +00:00
- [ghodss/yaml](https://github.com/ghodss/yaml)
2020-11-25 11:01:53 +00:00
- [gorilla/websocket](https://github.com/gorilla/websocket)
2023-02-02 05:50:21 +00:00
- [quic-go/quic-go](https://github.com/quic-go/quic-go)
2022-04-09 04:48:02 +00:00
- [pelletier/go-toml](https://github.com/pelletier/go-toml)
2020-11-25 11:01:53 +00:00
- [pires/go-proxyproto](https://github.com/pires/go-proxyproto)
2022-04-09 04:48:02 +00:00
- [refraction-networking/utls](https://github.com/refraction-networking/utls)
2020-11-25 11:01:53 +00:00
- [seiflotfy/cuckoofilter](https://github.com/seiflotfy/cuckoofilter)
- [google/starlark-go](https://github.com/google/starlark-go)
- For testing only:
- [miekg/dns](https://github.com/miekg/dns)
2022-04-09 04:48:02 +00:00
- [stretchr/testify](https://github.com/stretchr/testify)
2020-11-25 11:01:53 +00:00
- [h12w/socks](https://github.com/h12w/socks)
## Compilation
### Windows
```bash
2020-11-25 11:01:53 +00:00
go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main
```
### Linux / macOS
```bash
2020-11-25 11:01:53 +00:00
go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main
```
2020-11-29 06:35:37 +00:00
## Stargazers over time
[![Stargazers over time](https://starchart.cc/XTLS/Xray-core.svg)](https://starchart.cc/XTLS/Xray-core)