Xray HA Linux Archive / RPM/ Debian Installation

First node installation steps

1. Install the first node. The installation is identical to the single node installation.

⚠️

Warning

Do not start Xray after the installation at this point.

2. Configure the system.yaml file with the database and first node configuration details. For example,

   First node system.yaml

   YAML

   shared:
     database:
       type: postgresql
       driver: org.postgresql.Driver
       url: postgres://<ip:port>/xraydb?sslmode=disable
       username: xray
       password: xray
     jfrogUrl: <JFrog URL>
     security:
       joinKey: <Artifactory Join Key>
     rabbitMq:
           autoStop: true
           url: "amqp://localhost:5672/"

3. Start and manage the Xray service.

   systemd OS

   Bash

   systemctl start|stop xray.service

   Systemv OS

   Bash

   service xray start|stop

4. Access Xray from your browser at: http://<jfrogUrl>/ui/: go to the Xray Security & Compliance tab in the Administration module in the UI

5. Check the Xray log.

   Linux

   Bash

   tail -f $JFROG_HOME/xray/var/log/console.log

Additional node installation steps

For a node to join a cluster, the node must have the same database configuration and the Master Key.

📘

Note

The master key used by Xray is not the same one used by Artifactory.

1. Install all additional nodes using the same steps described above.

2. Configure PostgreSQL to allow external IP connections. This will ensure PostgreSQL is reachable by this node.

3. Configure the system.yaml file for the additional node with master key, database and active node configurations. For example,

   Additional node system.yaml

   YAML

   shared:
     database:
       type: postgresql
       driver: org.postgresql.Driver
       url: postgres://<ip:port>/xraydb?sslmode=disable
       username: xray
       password: xray
     jfrogUrl: <JFrog URL>
     security:
       joinKey: <Artifactory Join Key>  
     rabbitMq:
       autoStop: true
       url: "amqp://localhost:5672/"
       active:
         node:
           name: <hostname of any of the active nodes where Rabbit MQ service is running>
           ip:

   You can obtain the hostname of the first by running the following command on the first node.

   Bash

   hostname -s

4. Copy the master.key from the first node to the additional node located at $JFROG_HOME/xray/var/etc/security/master.key.

5. Start the additional node.

6. Access Xray from your browser at: http://<jfrogUrl>/ui/: go to the Xray Security & Compliance tab in the Administration module in the UI

7. Check the Xray log.

   Linux

   Bash

   tail -f $JFROG_HOME/xray/var/log/console.log