Get Started Installing Xray

The Big Picture

flowchart LR
    subgraph flow[" "]
        direction LR
        P["Platform & OS Support<br />Check supported OS,<br />architecture, platform"]
        H["Hardware & Sizing<br />Size nodes by<br />indexed artifact count"]
        R["Prerequisites<br />PostgreSQL, Erlang,<br />db-util"]
        N["Port Requirements<br />Open required<br />network ports"]
        I["Install Xray<br />Run the interactive<br />installer script"]

        P --> H --> R --> N --> I
    end

Before installing Xray, review the following:

• Platform and OS Support
• Hardware & Sizing
• Review the Xray port requirements
• Xray Interactive Script Installation Prerequisites

Installation: Choosing an Installer Script

Linux Archive, RPM, DEB, or Docker Compose

Use installV2.sh / configV2.sh — this is the recommended installer script.

• Use install.sh / config.sh only if you were already using it previously.
• If you're already on installV2.sh / configV2.sh, continue using it for future upgrades and for fresh installations.

Once you have reviewed the above, proceed to Xray Single Node Interactive Script Installation.

Xray HA Installation

For Xray HA installation, follow this doc.

Upgrade

1. Upgrading xray (RPM, Debian, linux-archive, Docker Compose)
2. Xray Helm Upgrade