scprime/xns-relayer repository overview

⁠Website Documentation

https://xns.tech/docs/index-documents/⁠

⁠Prerequisites

⁠Docker / Docker Compose

These are the main services used by the relayer.

⁠Snap Users

If you are using a SNAP version of Docker this is unsupported. Please switch your docker instance to a verified version using your operating systems package manager. E.g.

sudo snap remove docker
sudo apt install docker.io

⁠Installation

To install the latest version of the relayer create a new folder within your file system e.g. /home/user/xns/relayer and add the following files.

⁠docker-compose.yml

version: "3.4"
services:
  xns:
    container_name: xns-relayer
    image: scprime/xns-relayer:stable
    restart: unless-stopped
    volumes:
      - ${RELAYER}:/relayer
    ports:
      - ${UI_PORT}:8888
      - ${MINIO_PORT}:9000
    env_file:
      - .env

⁠.env

RELAYER=./data
UI_PORT=8888
MINIO_PORT=9000

⁠Starting, Stopping, and Updating

Please note: The following commands must be run from the directory where you placed docker-compose.yml in our examples case this was /home/user/xns/relayer

⁠Notes

Please be aware to copy the docker-compose.yml exactly as it is shown. Spacing matters in .yml files.