Xray-docs-next/docs/en/document/install.md

4.2 KiB

Download and Install

Platform Support

  • Xray is available on the following platforms:
    • Windows 7 and later (x86 / amd64 / arm32 / arm64);
    • 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 subsequent versions, CentOS 7 / 8, Arch Linux, etc.;
    • FreeBSD (x86 / amd64);
    • OpenBSD (x86 / amd64);
    • Dragonfly BSD (amd64);

Download Xray

Precompiled binaries in ZIP format are available at GitHub Releases found in.

Download the compressed package of the corresponding platform, and use it after decompression.

Verify the Installation Package

Xray provides two verification methods:

  • SHA1/SHA256 digest of the ZIP archive
  • Reproducible build: Please refer to Compile Xray

Install on Windows

  • Download the ZIP archive suitable for the Windows platform on Github Releases. After decompression, you can get an executable file xray.exe, and then run it with parameters through the command line.
  • By Scoop Package manager installation: Xray has been added to Mochi.

Install on macOS

  • Download the ZIP archive suitable for the macOS platform on Github Releases. After decompression, you can get an executable file xray, and then run it with parameters through the command line.
  • By Homebrew Package manager installation: brew install xray
  • homebrew-xray: Thanks @N4FA

Install on Linux

Install Script

Arch Linux

Arch User Repository

Need to use AUR helpers, yay as an example, it can be installed via yay -S xray.

Arch Linux CN

First add Arch Linux CN repository, and then use the root user pacman -S xrayto install.

Linuxbrew

The Linuxbrew package manager is used in the same way as Homebrew: brew install xray

Debian

Install via Docker

The File Structure of the Docker Image

  • /etc/xray/config.json: configuration file
  • /usr/bin/xray: Xray main program
  • /usr/local/share/xray/geoip.dat: IP data file
  • /usr/local/share/xray/geosite.dat: domain name data file

GUI Client

UUID Generator

Third-party UUID generator uuidgenerator.net