Skip to content
webpack
Sign in
Proxy Management

3x-ui Installer

Installs the 3x-ui panel as a system service with an admin login set from the parameters (the password is created by the platform and shown on the result page), a random panel path, and can set up PostgreSQL and an SSL certificate without prompts. On RHEL, Fedora, CentOS and Arch it first upgrades all system packages. A reinstall deletes the existing x-ui program folder, and a Let's Encrypt domain certificate deletes and recreates the folder /root/cert/<your domain>.

What it does

Management Panel Installers

What you will be asked

You fill these in during setup.

  • Installation folder RequiredAdvanced settings
    Folder where the x-ui program files are installed. The last part of the path must be x-ui. If this folder already exists, it is deleted and replaced. Keep the default unless you need another folder.
  • Service file folder RequiredAdvanced settings
    Folder where the x-ui systemd service file is placed. Keep the default unless your system keeps service files in another folder.
  • Version OptionalAdvanced settings
    The 3x-ui release to install, v2.3.5 or newer. Leave empty to install the latest release.
  • Server IPv4 address OptionalAdvanced settings
    Your server's public IPv4 address. It is used only if the address cannot be found automatically. Optional.
  • Database Required
    Choose where the panel stores its data. SQLite needs no setup and suits fewer than 1000 clients. PostgreSQL suits many clients or nodes. Used on a new installation only.
  • PostgreSQL setup OptionalAdvanced settings
    Used only with PostgreSQL. Choose whether PostgreSQL is installed on this server or an existing PostgreSQL server is used.
  • PostgreSQL connection address OptionalAdvanced settings
    Connection address of your existing PostgreSQL server, including its user name and password. Needed only when you use an existing server.
  • If PostgreSQL installation fails OptionalAdvanced settings
    Choose what happens if installing PostgreSQL on this server fails. Try again repeats the installation until it succeeds.
  • Set your own panel port? Required
    Choose Yes to set the panel port yourself. With No, the default, a random port is used. Used on a new installation only.
  • Panel port Optional
    The port the panel listens on. Needed only when Set your own panel port? is Yes.
  • Admin username Optional
    Enter the username for signing in to the panel. Used when the panel still has the default login (a new installation). Leave empty to use admin.
  • Admin password Made for you if left empty
    The platform creates a strong password unless you type one. It is shown on the result page. Used when the panel still has the default login (a new installation).
  • SSL certificate Required
    Choose how the panel gets an SSL certificate when it has none. Both Let's Encrypt options need port 80 open. No SSL is safe only behind a reverse proxy or an SSH tunnel.
  • Domain Optional
    Your domain for the Let's Encrypt domain certificate. It must point to this server. Needed only for that option.
  • Domain certificate check port OptionalAdvanced settings
    Port on this server that acme.sh listens on while Let's Encrypt checks your domain. Keep 80 unless port 80 is forwarded to another port.
  • IP certificate check port OptionalAdvanced settings
    Port on this server that acme.sh listens on while Let's Encrypt checks the server IP. Keep 80 unless port 80 is forwarded to another port.
  • Backup IP certificate check port OptionalAdvanced settings
    Port used for the IP certificate check when the port above is busy. If you leave it empty and that port is busy, the IP certificate is not created.
  • Server IPv6 address OptionalAdvanced settings
    IPv6 address of this server to add to the Let's Encrypt IP certificate. Optional.
  • Domain of your certificate OptionalAdvanced settings
    Domain your own certificate was issued for. It is used in the panel address. Leave empty to use the server IP.
  • Certificate file path OptionalAdvanced settings
    Full path on this server to your certificate file, such as fullchain.pem or a .crt file. Needed only for Use my own certificate.
  • Private key file path OptionalAdvanced settings
    Full path on this server to the private key file of your certificate. Needed only for Use my own certificate.
  • Panel on localhost only OptionalAdvanced settings
    Used only with No SSL. Choose Yes to make the panel reachable only from the server itself, for example through an SSH tunnel.
  • Change certificate reload command OptionalAdvanced settings
    Used only with the domain certificate. Choose Yes to change the command that runs after each certificate renewal.
  • Certificate reload command OptionalAdvanced settings
    Choose the command that runs after each certificate renewal. Used only when Change certificate reload command is Yes.
  • Your reload command OptionalAdvanced settings
    The command that runs after each certificate renewal. Needed only when you choose My own command.
  • Use certificate for panel OptionalAdvanced settings
    Used only with the domain certificate. Choose Yes to set the new certificate on the panel.

Reconnecting Could not reconnect The page is paused

The connection to the site dropped. We are bringing it back; your page stays as it is. Check your internet connection. We keep trying by ourselves, and the page reloads once the site answers. This page was paused to save resources. Resume it to continue.