install_relayer
Install and start the XNS Relayer, including Prometheus/Grafana monitoring. Fetches the canonical bundle, writes .env, and runs docker compose up -d with no manual file authoring.
Instructions
Install and start the XNS Relayer. By default fetches the canonical beta channel bundle — relayer + the Prometheus/Grafana monitoring stack — from releases.scpri.me (anonymous pull) and writes a .env, then runs docker compose up -d — the user does NOT need to author any file. Falls back to a bundled copy of the bundle if the fetch fails. Pass compose_url only to override with a custom compose.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| s3_port | No | Host port for the S3 API (container 9000) | |
| ui_port | No | Host port for the Relayer admin/customer UI (container 8888) | |
| compose_url | No | OPTIONAL override: URL to a custom docker-compose.yml. Omit for the normal released install. | |
| install_path | No | Directory to install the compose file into | /opt/xns-relayer |