forked from XTLS/Xray-core
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
de53a3b
commit 19d1de2
Showing
3 changed files
with
10 additions
and
355 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,147 +1,17 @@ | ||
# Project X | ||
# Xray-core | ||
|
||
[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). | ||
Forked version with some improvements. More info in original [repo](https://github.com/XTLS/Xray-core). | ||
|
||
[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). | ||
## Improvements | ||
|
||
## Donation & NFTs | ||
- Limit connections count per client using policy. **WIP** | ||
|
||
- **ETH/USDT/USDC: `0xDc3Fe44F0f25D13CACb1C4896CD0D321df3146Ee`** | ||
- **Project X NFT: [Announcement of NFTs by Project X](https://github.com/XTLS/Xray-core/discussions/3633)** | ||
- **REALITY NFT: [XHTTP: Beyond REALITY](https://github.com/XTLS/Xray-core/discussions/4113)** | ||
## Donation | ||
|
||
## 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) | ||
|
||
[Project VLESS](https://t.me/projectVless) (non-Chinese) | ||
|
||
## Installation | ||
|
||
- Linux Script | ||
- [XTLS/Xray-install](https://github.com/XTLS/Xray-install) (**Official**) | ||
- [tempest](https://github.com/team-cloudchaser/tempest) (supports [`systemd`](https://systemd.io) and [OpenRC](https://github.com/OpenRC/openrc); Linux-only) | ||
- Docker | ||
- [ghcr.io/xtls/xray-core](https://ghcr.io/xtls/xray-core) (**Official**) | ||
- [teddysun/xray](https://hub.docker.com/r/teddysun/xray) | ||
- [wulabing/xray_docker](https://github.com/wulabing/xray_docker) | ||
- Web Panel - **WARNING: Please DO NOT USE plain HTTP panels like 3X-UI**, as they are believed to be bribed by Iran GFW for supporting plain HTTP by default and refused to change (https://github.com/XTLS/Xray-core/pull/3884#issuecomment-2439595331), which has already put many users' data security in danger in the past few years. **If you are already using 3X-UI, please switch to the following panels, which are verified to support HTTPS and SSH port forwarding only:** | ||
- [Marzban](https://github.com/Gozargah/Marzban) | ||
- [Xray-UI](https://github.com/qist/xray-ui) | ||
- [Hiddify](https://github.com/hiddify/Hiddify-Manager) | ||
- One Click | ||
- [Xray-REALITY](https://github.com/zxcvos/Xray-script), [xray-reality](https://github.com/sajjaddg/xray-reality), [reality-ezpz](https://github.com/aleskxyz/reality-ezpz) | ||
- [Xray_bash_onekey](https://github.com/hello-yunshu/Xray_bash_onekey), [XTool](https://github.com/LordPenguin666/XTool) | ||
- [v2ray-agent](https://github.com/mack-a/v2ray-agent), [Xray_onekey](https://github.com/wulabing/Xray_onekey), [ProxySU](https://github.com/proxysu/ProxySU) | ||
- Magisk | ||
- [Xray4Magisk](https://github.com/Asterisk4Magisk/Xray4Magisk) | ||
- [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk) | ||
- Homebrew | ||
- `brew install xray` | ||
|
||
## 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/) | ||
- [XTLS-Iran-Reality (English)](https://github.com/SasukeFreestyle/XTLS-Iran-Reality) | ||
- [Xray REALITY with 'steal oneself' (English)](https://computerscot.github.io/vless-xtls-utls-reality-steal-oneself.html) | ||
- [Xray with WireGuard inbound (English)](https://g800.pages.dev/wireguard) | ||
|
||
## GUI Clients | ||
|
||
- OpenWrt | ||
- [PassWall](https://github.com/xiaorouji/openwrt-passwall), [PassWall 2](https://github.com/xiaorouji/openwrt-passwall2) | ||
- [ShadowSocksR Plus+](https://github.com/fw876/helloworld) | ||
- [luci-app-xray](https://github.com/yichya/luci-app-xray) ([openwrt-xray](https://github.com/yichya/openwrt-xray)) | ||
- Windows | ||
- [v2rayN](https://github.com/2dust/v2rayN) | ||
- [Furious](https://github.com/LorenEteval/Furious) | ||
- [Invisible Man - Xray](https://github.com/InvisibleManVPN/InvisibleMan-XRayClient) | ||
- Android | ||
- [v2rayNG](https://github.com/2dust/v2rayNG) | ||
- [X-flutter](https://github.com/XTLS/X-flutter) | ||
- [SaeedDev94/Xray](https://github.com/SaeedDev94/Xray) | ||
- iOS & macOS arm64 | ||
- [FoXray](https://apps.apple.com/app/foxray/id6448898396) | ||
- [Streisand](https://apps.apple.com/app/streisand/id6450534064) | ||
- macOS arm64 & x64 | ||
- [V2rayU](https://github.com/yanue/V2rayU) | ||
- [V2RayXS](https://github.com/tzmax/V2RayXS) | ||
- [Furious](https://github.com/LorenEteval/Furious) | ||
- [FoXray](https://apps.apple.com/app/foxray/id6448898396) | ||
- Linux | ||
- [v2rayA](https://github.com/v2rayA/v2rayA) | ||
- [Furious](https://github.com/LorenEteval/Furious) | ||
- **ETH: `0xbdD857a41507006F648Cb08DCaf57b36Cb1560c8`** | ||
- **BTC: `bc1q94jqe2gvm8zjtfc4h0m4p6jt3dlkasjjxrhaph`** | ||
- **TRX: `TMzXAmfxQRYyNHMaCQWqckkY6Y97oqrhWf`** | ||
|
||
## Others that support VLESS, XTLS, REALITY, XUDP, PLUX... | ||
|
||
- iOS & macOS arm64 | ||
- [Shadowrocket](https://apps.apple.com/app/shadowrocket/id932747118) | ||
- Xray Tools | ||
- [xray-knife](https://github.com/lilendian0x00/xray-knife) | ||
- Xray Wrapper | ||
- [XTLS/libXray](https://github.com/XTLS/libXray) | ||
- [xtlsapi](https://github.com/hiddify/xtlsapi) | ||
- [AndroidLibXrayLite](https://github.com/2dust/AndroidLibXrayLite) | ||
- [Xray-core-python](https://github.com/LorenEteval/Xray-core-python) | ||
- [xray-api](https://github.com/XVGuardian/xray-api) | ||
- [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) | ||
- [clashN](https://github.com/2dust/clashN) | ||
- [Clash Meta for Android](https://github.com/MetaCubeX/ClashMetaForAndroid) | ||
- [sing-box](https://github.com/SagerNet/sing-box) | ||
|
||
## Contributing | ||
|
||
[Code of Conduct](https://github.com/XTLS/Xray-core/blob/main/CODE_OF_CONDUCT.md) | ||
|
||
## Credits | ||
|
||
- [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). | ||
- 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). | ||
|
||
## Compilation | ||
|
||
### Windows (PowerShell) | ||
|
||
```powershell | ||
$env:CGO_ENABLED=0 | ||
go build -o xray.exe -trimpath -ldflags "-s -w -buildid=" ./main | ||
``` | ||
|
||
### Linux / macOS | ||
|
||
```bash | ||
CGO_ENABLED=0 go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main | ||
``` | ||
|
||
### Reproducible Releases | ||
|
||
```bash | ||
make | ||
``` | ||
|
||
## Stargazers over time | ||
## License | ||
|
||
[![Stargazers over time](https://starchart.cc/XTLS/Xray-core.svg)](https://starchart.cc/XTLS/Xray-core) | ||
[Mozilla Public License Version 2.0](https://github.com/XTLS/Xray-core/blob/main/LICENSE) |