Xray-core/README.md

96 lines
3.3 KiB
Markdown
Raw Normal View History

2020-11-25 13:01:53 +02:00
# Project X
[Project X](https://github.com/XTLS) originates from XTLS protocol, provides a set of network tools such as [Xray-core](https://github.com/XTLS/Xray-core) and [Xray-flutter](https://github.com/XTLS/Xray-flutter).
2020-11-27 10:33:31 +02:00
## License
[Mozilla Public License Version 2.0](https://github.com/XTLS/Xray-core/blob/main/LICENSE)
2020-11-25 13:01:53 +02:00
## Installation
2020-11-27 05:08:28 +02:00
- Linux Script
2020-11-25 13:01:53 +02:00
- [Xray-install](https://github.com/XTLS/Xray-install)
2020-11-27 08:28:34 +02:00
- [Xray-script](https://github.com/kirin10000/Xray-script)
2020-11-25 14:27:18 +02:00
- Docker
- [teddysun/xray](https://hub.docker.com/r/teddysun/xray)
2020-12-11 11:32:13 +02:00
- Xray-docker
2020-11-27 05:08:28 +02:00
- One Click
- [ProxySU](https://github.com/proxysu/ProxySU)
- [v2ray-agent](https://github.com/mack-a/v2ray-agent)
2021-02-15 12:50:30 +02:00
- [Xray-yes](https://github.com/jiuqi9997/Xray-yes)
2021-02-22 04:21:17 +02:00
- [Xray_onekey](https://github.com/wulabing/Xray_onekey)
2020-12-01 12:20:29 +02:00
- Magisk
- [Xray4Magisk](https://github.com/CerteKim/Xray4Magisk)
- [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk)
2020-12-24 14:43:19 +02:00
- Homebrew
- `brew install xray`
- [(Tap) Repository 0](https://github.com/N4FA/homebrew-xray)
- [(Tap) Repository 1](https://github.com/xiruizhao/homebrew-xray)
2020-11-25 13:01:53 +02:00
## Contributing
[Code Of Conduct](https://github.com/XTLS/Xray-core/blob/main/CODE_OF_CONDUCT.md)
2020-11-25 13:01:53 +02:00
## Usage
[Xray-examples](https://github.com/XTLS/Xray-examples) / [VLESS-TCP-XTLS-WHATEVER](https://github.com/XTLS/Xray-examples/tree/main/VLESS-TCP-XTLS-WHATEVER)
2020-12-01 12:22:07 +02:00
## GUI Clients
- OpenWrt
- [PassWall](https://github.com/xiaorouji/openwrt-passwall)
2020-12-13 07:55:38 +02:00
- [Hello World](https://github.com/jerrykuku/luci-app-vssr)
- [ShadowSocksR Plus+](https://github.com/fw876/helloworld)
2021-01-27 00:50:28 +02:00
- [luci-app-xray](https://github.com/yichya/luci-app-xray) ([openwrt-xray](https://github.com/yichya/openwrt-xray))
2020-12-01 12:22:07 +02:00
- Windows
- [v2rayN](https://github.com/2dust/v2rayN)
- [Qv2ray](https://github.com/Qv2ray/Qv2ray) (This project had been archived and currently inactive)
2021-02-15 11:10:19 +02:00
- [Netch (NetFilter & TUN/TAP)](https://github.com/NetchX/Netch)
2020-12-01 12:22:07 +02:00
- Android
- [v2rayNG](https://github.com/2dust/v2rayNG)
2021-06-20 18:13:37 +03:00
- [AnXray](https://github.com/XTLS/AnXray)
2020-12-13 08:21:50 +02:00
- [Kitsunebi](https://github.com/rurirei/Kitsunebi/tree/release_xtls)
- iOS & macOS (with M1 chip)
2020-12-01 12:22:07 +02:00
- [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118)
- macOS (Intel chip & M1 chip)
- [Qv2ray](https://github.com/Qv2ray/Qv2ray) (This project had been archived and currently inactive)
2020-12-01 12:22:07 +02:00
2020-11-25 13:01:53 +02:00
## Credits
This repo relies on the following third-party projects:
- Special thanks:
- [v2fly/v2ray-core](https://github.com/v2fly/v2ray-core)
- In production:
- [gorilla/websocket](https://github.com/gorilla/websocket)
- [lucas-clemente/quic-go](https://github.com/lucas-clemente/quic-go)
- [pires/go-proxyproto](https://github.com/pires/go-proxyproto)
- [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)
- [h12w/socks](https://github.com/h12w/socks)
## Compilation
### Windows
```bash
2020-11-25 13:01:53 +02:00
go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main
```
### Linux / macOS
```bash
2020-11-25 13:01:53 +02:00
go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main
```
## Telegram
[Project X](https://t.me/projectXray)
[Project X Channel](https://t.me/projectXtls)
2020-11-29 08:35:37 +02:00
## Stargazers over time
[![Stargazers over time](https://starchart.cc/XTLS/Xray-core.svg)](https://starchart.cc/XTLS/Xray-core)