Max/XTLS_Xray-docs-next
1
0
Fork 0
mirror of https://github.com/XTLS/Xray-docs-next.git synced 2026-10-05 05:18:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

Refactor install and remove outdated projects

Browse Source
This commit is contained in:
Meow
2026-05-10 06:21:53 +08:00
parent 0bb66220a0
commit 95b918b8c8
3 changed files with 330 additions and 386 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/document/install.md
+110 -129
View File
@@ -2,166 +2,147 @@
## Platform Support
Xray is available on the following platforms:
Official Releases support the following platforms
- Windows 7 and later (x86 / amd64 / arm32 / arm64);
- To use regular versions 1.8.4, 1.8.6, and `win7` versions after 1.8.18 on Windows 7, the system must have the **KB4474419** update installed; it is recommended to also install KB4490628 to receive subsequent operating system security updates after connecting to the internet.
- Starting from v25, running the `win7` version on Windows 7 only requires SP1 to function normally, but installing subsequent OS security updates is still strongly recommended for networked systems.
- macOS 10.10 Yosemite and later (amd64 / arm64);
- Linux 2.6.23 and later (x86 / amd64 / arm / arm64 / mips64 / mips / ppc64 / s390x / riscv64);
- Including but not limited to Debian 7 / 8, Ubuntu 12.04 / 14.04 and later, CentOS 7 / 8, Arch Linux, etc.;
- FreeBSD (x86 / amd64);
- OpenBSD (x86 / amd64);
| Platform | Minimum Version | Architectures |
| :------- | :------------------------------------------------------------- | :------------------------------------------------------------------ |
| Windows | 7 and later <sup><a href="#platform-note-1">[1]</a></sup> | x86 / amd64 / arm32 / arm64 |
| macOS | 10.10 Yosemite and later | amd64 / arm64 |
| Linux | 2.6.23 and later <sup><a href="#platform-note-2">[2]</a></sup> | x86 / amd64 / arm / arm64 / mips64 / mips / ppc64 / s390x / riscv64 |
| FreeBSD | - | x86 / amd64 |
| OpenBSD | - | x86 / amd64 |
<small id="platform-note-1">[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.</small>
<small id="platform-note-2">[2] Including but not limited to Debian 7 / 8, Ubuntu 12.04 / 14.04 and later, CentOS 7 / 8, Arch Linux, and more.</small>
## Download Xray
Pre-compiled binary ZIP archives can be found in [Github Releases](https://github.com/xtls/Xray-core/releases).
Precompiled binary ZIP archives are available in [Github Releases](https://github.com/xtls/Xray-core/releases).
Download the archive for your platform, extract it, and it is ready to use.
Download the archive for your platform and extract it to start using Xray.
## Verify Installation Packages
Xray provides two verification methods:
- SHA1 / SHA256 digests of the ZIP archive.
- Reproducible Builds: Please refer to [Compiling Xray](../development/intro/compile.md).
- SHA1 / SHA256 digests for ZIP archives
- Reproducible builds: please refer to [Compile Xray](../development/intro/compile.md)
## Windows Installation
- Download the ZIP archive for the Windows platform from [Github Releases](https://github.com/xtls/Xray-core/releases). After extraction, you will get the executable file `xray.exe`. You can then [run it via the command line with parameters](./command).
- Install via [Scoop](https://scoop.sh) package manager: Xray has been added to [Mochi](https://github.com/Qv2ray/mochi).
- Download the ZIP archive for Windows from [Github Releases](https://github.com/xtls/Xray-core/releases). After extracting it, you will get the executable file `xray.exe`, which you can then [run with command-line arguments](./command)
## macOS Installation
- Download the ZIP archive for the macOS platform from [Github Releases](https://github.com/xtls/Xray-core/releases). After extraction, you will get the executable file `xray`. You can then [run it via the command line with parameters](./command.md).
- Install via [Homebrew](https://brew.sh) package manager: `brew install xray`
- [homebrew-xray](https://github.com/N4FA/homebrew-xray) thanks to [@N4FA](https://github.com/N4FA).
- Download the ZIP archive for macOS from [Github Releases](https://github.com/xtls/Xray-core/releases). After extracting it, you will get the executable file `xray`, which you can then [run with command-line arguments](./command.md)
- Install via the [Homebrew](https://brew.sh) package manager: `brew install xray`
- [homebrew-xray](https://github.com/N4FA/homebrew-xray) thanks to [@N4FA](https://github.com/N4FA)
## Linux Installation
### Installation Scripts
### Installation Scripts and Projects
- Linux Script
- [XTLS/Xray-install](https://github.com/XTLS/Xray-install) (**Official Script**)
- [tempest](https://github.com/team-cloudchaser/tempest) (Supports [`systemd`](https://systemd.io) and [OpenRC](https://github.com/OpenRC/openrc); Linux only)
| Type | Project | Description |
| :----------- | :----------------------------------------------------------------------- | :---------------------------------------------------------------------------------------- |
| Linux Script | [XTLS/Xray-install](https://github.com/XTLS/Xray-install) (**Official**) | Officially maintained Linux installation script |
| Linux Script | [tempest](https://github.com/team-cloudchaser/tempest) | Supports [`Systemd`](https://systemd.io) and [`OpenRC`](https://github.com/OpenRC/openrc) |
| One Click | [Xray-REALITY](https://github.com/zxcvos/Xray-script) | One-click installation solution |
| One Click | [reality-ezpz](https://github.com/aleskxyz/reality-ezpz) | One-click installation solution |
| One Click | [Xray_bash_onekey](https://github.com/hello-yunshu/Xray_bash_onekey) | One-click installation solution |
| One Click | [v2ray-agent](https://github.com/mack-a/v2ray-agent) | One-click installation solution |
| One Click | [ProxySU](https://github.com/proxysu/ProxySU) | One-click installation solution |
| Magisk | [Xray4Magisk](https://github.com/Asterisk4Magisk/Xray4Magisk) | For Magisk environments |
| Magisk | [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk) | For Magisk environments |
- 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)
### Package Managers and Distribution Repositories
- Magisk
- [Xray4Magisk](https://github.com/Asterisk4Magisk/Xray4Magisk)
- [Xray_For_Magisk](https://github.com/E7KMbb/Xray_For_Magisk)
### Arch Linux
#### Arch User Repository
Requires [AUR helpers](https://wiki.archlinux.org/index.php/AUR_helpers). Taking [yay](https://github.com/Jguer/yay) as an example, you can install via `yay -S xray`.
#### Arch Linux CN
First add the [Arch Linux CN repository](https://www.archlinuxcn.org/archlinux-cn-repo-and-mirror/), then install using `pacman -S xray` under the root user.
### Linuxbrew
The usage of the Linuxbrew package manager is consistent with Homebrew: `brew install xray`
### Debian <Badge text="WIP" type="warning"/>
### Gentoo
Currently, three third-party Overlays provide Portage installation scripts:
- [CHN-beta/touchfish-os](https://github.com/gentoo-mirror/touchfish-os/tree/master/net-proxy/Xray): Personally maintained, suitable for systemD systems.
- [Gentoo-zh](https://github.com/microcai/gentoo-zh): Community maintained, suitable for systemD systems.
- [JuanCldCmt/Xray-Overlay](https://github.com/JuanCldCmt/Xray-Overlay): Personally maintained, suitable for openRC systems; runs with the xray user group to improve security.
Use layman or eselect-repository to add the Overlay locally, then install.
| Method | Project | Description |
| :------------------- | :------------------------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------- |
| Arch User Repository | [AUR helpers](https://wiki.archlinux.org/index.php/AUR_helpers) | Taking [yay](https://github.com/Jguer/yay) as an example, install with `yay -S xray` |
| Arch Linux CN | [Arch Linux CN repository](https://www.archlinuxcn.org/archlinux-cn-repo-and-mirror/) | After adding the repository, install with `pacman -S xray` as root |
| Linuxbrew | [Homebrew](https://brew.sh) | Usage is the same as Homebrew: `brew install xray` |
| Gentoo Portage | [Gentoo-zh](https://github.com/microcai/gentoo-zh) | Suitable for Systemd systems; install after adding the Overlay with layman or eselect-repository |
## Docker Installation
Currently, two different styles of Docker images are provided:
Two different styles of Docker images are currently provided:
- [teddysun/xray](https://hub.docker.com/r/teddysun/xray): Has root privileges, has shell environment, compatible with all Alpine-supported architectures. Compiled and built by private server dl.lamp.sh. More convenient to use.
- [ghcr.io/xtls/xray-core](https://ghcr.io/xtls/xray-core): No root privileges, no shell environment, supports more architectures. Compiled and built by the official repository supporting traceability. Sacrifices convenience for more extreme security.
- [ghcr.io/xtls/xray-core](https://ghcr.io/xtls/xray-core) (**Official**)<br>
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
### Docker Image File Structure
:::
teddysun/xray version image:
- [teddysun/xray](https://hub.docker.com/r/teddysun/xray)<br>
Has root privileges, includes a shell environment, and is compatible with all architectures supported by Alpine. It is compiled and built by the private server `dl.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
- `/usr/bin/xray`: Xray main program
- `/etc/xray/config.json`: Single configuration file (its directory is a mount point)
- `/usr/share/xray/`: Resource file directory, stores v2fly version geolocation data files
- geoip.dat
- geosite.dat
:::
ghcr.io/xtls/xray-core version image:
## Third-Party Graphical Clients
- `/usr/local/bin/xray`: Xray main program (Owner is root:root, file permissions 755)
- `/usr/local/etc/xray/`: Configuration file directory (Mount point) (Owner is 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, stores Loyalsoldier version geolocation data files (Permissions same as above)
- geoip.dat
- geosite.dat
- `/var/log/xray/`: Log file directory (Mount point) (Directory owner is root:root, permissions 755; File owner is 65532:65532, permissions 600)
- access.log
- error.log
# Graphical 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))
- Asuswrt-Merlin
- [XRAYUI](https://github.com/DanielLavrushin/asuswrt-merlin-xrayui)
- Windows
- [v2rayA](https://github.com/v2rayA/v2rayA)
- [v2rayN](https://github.com/2dust/v2rayN)
- [Furious](https://github.com/LorenEteval/Furious)
- [Invisible Man - Xray](https://github.com/InvisibleManVPN/InvisibleMan-XRayClient)
- [AnyPortal](https://github.com/AnyPortal/AnyPortal)
- Android
- [v2rayNG](https://github.com/2dust/v2rayNG)
- [X-flutter](https://github.com/XTLS/X-flutter)
- [SaeedDev94/Xray](https://github.com/SaeedDev94/Xray)
- [SimpleXray](https://github.com/lhear/SimpleXray)
- [AnyPortal](https://github.com/AnyPortal/AnyPortal)
- iOS & macOS arm64 & tvOS
- [Happ](https://apps.apple.com/app/happ-proxy-utility/id6504287215) ([tvOS](https://apps.apple.com/us/app/happ-proxy-utility-for-tv/id6748297274))
- [FoXray](https://apps.apple.com/app/foxray/id6448898396)
- [Streisand](https://apps.apple.com/app/streisand/id6450534064)
- macOS arm64 & x64
- [Happ](https://apps.apple.com/app/happ-proxy-utility/id6504287215)
- [v2rayA](https://github.com/v2rayA/v2rayA)
- [v2rayN](https://github.com/2dust/v2rayN)
- [V2rayU](https://github.com/yanue/V2rayU)
- [V2RayXS](https://github.com/tzmax/V2RayXS)
- [Furious](https://github.com/LorenEteval/Furious)
- [OneXray](https://github.com/OneXray/OneXray)
- [GoXRay](https://github.com/goxray/desktop)
- [AnyPortal](https://github.com/AnyPortal/AnyPortal)
- Linux
- [v2rayA](https://github.com/v2rayA/v2rayA)
- [v2rayN](https://github.com/2dust/v2rayN)
- [Furious](https://github.com/LorenEteval/Furious)
- [GorzRay](https://github.com/ketetefid/GorzRay)
- [GoXRay](https://github.com/goxray/desktop)
- [AnyPortal](https://github.com/AnyPortal/AnyPortal)
| Platform | Project |
| :----------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------ |
| OpenWrt | [PassWall](https://github.com/Openwrt-Passwall/openwrt-passwall) |
| OpenWrt | [PassWall 2](https://github.com/Openwrt-Passwall/openwrt-passwall2) |
| OpenWrt | [ShadowSocksR Plus+](https://github.com/fw876/helloworld) |
| OpenWrt | [luci-app-xray](https://github.com/yichya/luci-app-xray) ([openwrt-xray](https://github.com/yichya/openwrt-xray)) |
| Asuswrt-Merlin | [XRAYUI](https://github.com/DanielLavrushin/asuswrt-merlin-xrayui) |
| Windows | [v2rayA](https://github.com/v2rayA/v2rayA) |
| Windows | [v2rayN](https://github.com/2dust/v2rayN) |
| Windows | [Furious](https://github.com/LorenEteval/Furious) |
| Windows | [Invisible Man - Xray](https://github.com/InvisibleManVPN/InvisibleMan-XRayClient) |
| Windows | [AnyPortal](https://github.com/AnyPortal/AnyPortal) |
| Android | [v2rayNG](https://github.com/2dust/v2rayNG) |
| Android | [X-flutter](https://github.com/XTLS/X-flutter) |
| Android | [SaeedDev94/Xray](https://github.com/SaeedDev94/Xray) |
| Android | [SimpleXray](https://github.com/lhear/SimpleXray) |
| Android | [AnyPortal](https://github.com/AnyPortal/AnyPortal) |
| iOS / macOS arm64 / tvOS | [Happ](https://apps.apple.com/app/happ-proxy-utility/id6504287215) ([tvOS](https://apps.apple.com/us/app/happ-proxy-utility-for-tv/id6748297274)) |
| iOS / macOS arm64 / tvOS | [FoXray](https://apps.apple.com/app/foxray/id6448898396) |
| iOS / macOS arm64 / tvOS | [Streisand](https://apps.apple.com/app/streisand/id6450534064) |
| macOS arm64 / x64 | [Happ](https://apps.apple.com/app/happ-proxy-utility/id6504287215) |
| macOS arm64 / x64 | [v2rayA](https://github.com/v2rayA/v2rayA) |
| macOS arm64 / x64 | [v2rayN](https://github.com/2dust/v2rayN) |
| macOS arm64 / x64 | [V2rayU](https://github.com/yanue/V2rayU) |
| macOS arm64 / x64 | [V2RayXS](https://github.com/tzmax/V2RayXS) |
| macOS arm64 / x64 | [Furious](https://github.com/LorenEteval/Furious) |
| macOS arm64 / x64 | [OneXray](https://github.com/OneXray/OneXray) |
| macOS arm64 / x64 | [GoXRay](https://github.com/goxray/desktop) |
| macOS arm64 / x64 | [AnyPortal](https://github.com/AnyPortal/AnyPortal) |
| Linux | [v2rayA](https://github.com/v2rayA/v2rayA) |
| Linux | [v2rayN](https://github.com/2dust/v2rayN) |
| Linux | [Furious](https://github.com/LorenEteval/Furious) |
| Linux | [GorzRay](https://github.com/ketetefid/GorzRay) |
| Linux | [GoXRay](https://github.com/goxray/desktop) |
| Linux | [AnyPortal](https://github.com/AnyPortal/AnyPortal) |
## UUID Generator