14 KiB
Download and Install
Platform Support
Official Releases support the following platforms
| Platform | Minimum Version | Architectures |
|---|---|---|
| Windows | 7 and later [1] | x86 / amd64 / arm32 / arm64 |
| macOS | 10.10 Yosemite and later | amd64 / arm64 |
| Linux | 2.6.23 and later [2] | x86 / amd64 / arm / arm64 / mips64 / mips / ppc64 / s390x / riscv64 |
| FreeBSD | - | x86 / amd64 |
| OpenBSD | - | x86 / amd64 |
[1] On Windows 7, regular versions 1.8.4 and 1.8.6, as well as win7 builds after 1.8.18, require KB4474419 to be installed. Installing KB4490628 is also recommended so the system can continue receiving later security updates after connecting to the internet. Starting from v25, the win7 build on Windows 7 only requires SP1 to run normally, but installing later OS security updates is still strongly recommended for networked systems.
[2] Including but not limited to Debian 7 / 8, Ubuntu 12.04 / 14.04 and later, CentOS 7 / 8, Arch Linux, and more.
Download Xray
Precompiled binary ZIP archives are available in Github Releases.
Download the archive for your platform and extract it to start using Xray.
Verify Installation Packages
Xray provides two verification methods:
- SHA1 / SHA256 digests for ZIP archives
- Reproducible builds: please refer to Compile Xray
Windows Installation
- Download the ZIP archive for Windows from Github Releases. After extracting it, you will get the executable file
xray.exe, which you can then run with command-line arguments
macOS Installation
- Download the ZIP archive for macOS from Github Releases. After extracting it, you will get the executable file
xray, which you can then run with command-line arguments - Install via the Homebrew package manager:
brew install xray - homebrew-xray thanks to @N4FA
Linux Installation
Installation Scripts and Projects
| Type | Project | Description |
|---|---|---|
| Linux Script | XTLS/Xray-install (Official) | Officially maintained Linux installation script |
| Linux Script | tempest | Supports Systemd and OpenRC |
| One Click | Xray-REALITY | One-click installation solution |
| One Click | reality-ezpz | One-click installation solution |
| One Click | Xray_bash_onekey | One-click installation solution |
| One Click | v2ray-agent | One-click installation solution |
| One Click | ProxySU | One-click installation solution |
| Magisk | Xray4Magisk | For Magisk environments |
| Magisk | Xray_For_Magisk | For Magisk environments |
Package Managers and Distribution Repositories
| Method | Project | Description |
|---|---|---|
| Arch User Repository | AUR helpers | Taking yay as an example, install with yay -S xray |
| Arch Linux CN | Arch Linux CN repository | After adding the repository, install with pacman -S xray as root |
| Linuxbrew | Homebrew | Usage is the same as Homebrew: brew install xray |
| Gentoo Portage | Gentoo-zh | Suitable for Systemd systems; install after adding the Overlay with layman or eselect-repository |
Docker Installation
Two different styles of Docker images are currently provided:
-
ghcr.io/xtls/xray-core (Official)
No root privileges, no shell environment, and support for more architectures. It is compiled and built from the official repository with traceability support. It sacrifices convenience in pursuit of more extreme security. ::: details File Structure/usr/local/bin/xray: Xray main program (owner:root:root, file permissions:755)/usr/local/etc/xray/: Configuration file directory (mount point) (owner:root:root, directory permissions:755, file permissions:644)- 00_log.json
- 01_api.json
- 02_dns.json
- 03_routing.json
- 04_policy.json
- 05_inbounds.json
- 06_outbounds.json
- 07_stats.json
- 08_fakedns.json
- 09_metrics.json
- 10_observatory.json
- 11_geodata.json
- 99_version.json
/usr/local/share/xray/: Resource file directory containing Loyalsoldier geolocation data files (same permissions as above)- geoip.dat
- geosite.dat
/var/log/xray/: Log file directory (mount point) (directory owner:root:root, permissions:755; file owner:65532:65532, permissions:600)- access.log
- error.log
:::
-
teddysun/xray
Has root privileges, includes a shell environment, and is compatible with all architectures supported by Alpine. It is compiled and built by the private serverdl.lamp.sh. More convenient to use. ::: details File Structure/usr/bin/xray: Xray main program/etc/xray/config.json: Single configuration file (its parent directory is a mount point)/usr/share/xray/: Resource file directory containing v2fly geolocation data files- geoip.dat
- geosite.dat
:::
Third-Party Graphical Clients
| Platform | Project |
|---|---|
| OpenWrt | PassWall |
| OpenWrt | PassWall 2 |
| OpenWrt | ShadowSocksR Plus+ |
| OpenWrt | luci-app-xray (openwrt-xray) |
| Asuswrt-Merlin | XRAYUI |
| Windows | v2rayA |
| Windows | v2rayN |
| Windows | Furious |
| Windows | Invisible Man - Xray |
| Windows | AnyPortal |
| Android | v2rayNG |
| Android | X-flutter |
| Android | SaeedDev94/Xray |
| Android | SimpleXray |
| Android | AnyPortal |
| iOS / macOS arm64 / tvOS | Happ (tvOS) |
| iOS / macOS arm64 / tvOS | FoXray |
| iOS / macOS arm64 / tvOS | Streisand |
| macOS arm64 / x64 | Happ |
| macOS arm64 / x64 | v2rayA |
| macOS arm64 / x64 | v2rayN |
| macOS arm64 / x64 | V2rayU |
| macOS arm64 / x64 | V2RayXS |
| macOS arm64 / x64 | Furious |
| macOS arm64 / x64 | OneXray |
| macOS arm64 / x64 | GoXRay |
| macOS arm64 / x64 | AnyPortal |
| Linux | v2rayA |
| Linux | v2rayN |
| Linux | Furious |
| Linux | GorzRay |
| Linux | GoXRay |
| Linux | AnyPortal |
UUID Generator
Third-party UUID generator: uuidgenerator.net