Xray-core/README.md

# 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).

## License

[Mozilla Public License Version 2.0](https://github.com/XTLS/Xray-core/blob/main/LICENSE)

## Installation

- Linux Script
  - [Xray-install](https://github.com/XTLS/Xray-install)
  - [Xray-script](https://github.com/kirin10000/Xray-script)
- Docker
  - [teddysun/xray](https://hub.docker.com/r/teddysun/xray)
  - [charlieethan](https://github.com/users/charlieethan/packages/container/package/xray)
- One Click
  - [ProxySU](https://github.com/proxysu/ProxySU)
  - [v2ray-agent](https://github.com/mack-a/v2ray-agent)
- Magisk
  - [Xray4Magisk](https://github.com/CerteKim/Xray4Magisk)
  - [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk)

## 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)

## GUI Clients

- OpenWrt
  - [PassWall](https://github.com/xiaorouji/openwrt-passwall)
- Windows
  - [v2rayN](https://github.com/2dust/v2rayN)
- Android
  - [v2rayNG](https://github.com/2dust/v2rayNG)
- iOS / Mac
  - [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118)

## 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

```
go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main
```

### Linux / macOS

```
go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main
```

## Telegram

[Project X](https://t.me/projectXray)

[Project X Channel](https://t.me/projectXtls)

## Stargazers over time

[![Stargazers over time](https://starchart.cc/XTLS/Xray-core.svg)](https://starchart.cc/XTLS/Xray-core)
v1.0.0 2020-11-25 11:01:53 +00: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).`

Add Docker (GitHub Packages) 2020-11-27 08:33:31 +00:00			`## License`

			`[Mozilla Public License Version 2.0](https://github.com/XTLS/Xray-core/blob/main/LICENSE)`

v1.0.0 2020-11-25 11:01:53 +00:00			`## Installation`

Add One Click 2020-11-27 03:08:28 +00:00			`- Linux Script`
v1.0.0 2020-11-25 11:01:53 +00:00			`- [Xray-install](https://github.com/XTLS/Xray-install)`
Add Xray-script 2020-11-27 06:28:34 +00:00			`- [Xray-script](https://github.com/kirin10000/Xray-script)`
Add Docker 2020-11-25 12:27:18 +00:00			`- Docker`
			`- [teddysun/xray](https://hub.docker.com/r/teddysun/xray)`
Add Docker (GitHub Packages) 2020-11-27 08:33:31 +00:00			`- [charlieethan](https://github.com/users/charlieethan/packages/container/package/xray)`
Add One Click 2020-11-27 03:08:28 +00:00			`- One Click`
			`- [ProxySU](https://github.com/proxysu/ProxySU)`
			`- [v2ray-agent](https://github.com/mack-a/v2ray-agent)`
Add Magisk 2020-12-01 10:20:29 +00:00			`- Magisk`
			`- [Xray4Magisk](https://github.com/CerteKim/Xray4Magisk)`
			`- [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk)`
v1.0.0 2020-11-25 11:01:53 +00: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)`

Add GUI Clients 2020-12-01 10:22:07 +00:00			`## GUI Clients`

			`- OpenWrt`
			`- [PassWall](https://github.com/xiaorouji/openwrt-passwall)`
			`- Windows`
			`- [v2rayN](https://github.com/2dust/v2rayN)`
			`- Android`
			`- [v2rayNG](https://github.com/2dust/v2rayNG)`
			`- iOS / Mac`
			`- [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118)`

v1.0.0 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:`
			`- [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`

			```
			`go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main`
			```

			`### Linux / macOS`

			```
			`go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main`
			```

			`## Telegram`

			`[Project X](https://t.me/projectXray)`

			`[Project X Channel](https://t.me/projectXtls)`
Add Stargazers over time 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)`