Install Horizon API Gateway

RPM

Horizon API Gateway is available as a packaged RPM. This RPM will install the following components:

  • the horizon-api-gateway binary in /usr/bin

  • the configuration file in /etc/horizon-api-gateway/Caddyfile

  • the service file in /usr/lib/systemd/system/horizon-api-gateway.service

  • the horizon-api-gateway user and group that the service runs as

It will also start the service with the default configuration, running on port 80.

Installation from the EverTrust repository

Create a /etc/yum.repos.d/horizon-api-gateway.repo file containing the EverTrust repository info:

[horizon]
enabled=1
name=Horizon API Gateway Repository
baseurl=https://repo.evertrust.io/repository/horizon-api-gateway-rpm/
gpgcheck=0
username=<username>
password=<password>

Replace <username> and <password> with the credentials you were provided.

You can then run the following to install the latest Horizon version:

$ yum install horizon-api-gateway

To prevent unattended upgrades when running yum update, you should pin the Horizon version by adding

exclude=horizon-api-gateway

at the end of the /etc/yum.repos.d/horizon-api-gateway.repo file after installing Horizon API Gateway.

Installing from RPM

Upload the file horizon-api-gateway_<version>.rpm through SCP under /root.

Access the server through SSH with an account with administrative privileges;

Install the Horizon API Gateway package with the following command:

$ yum localinstall /root/horizon-api-gateway_<version>.rpm

Docker

Horizon API Gateway is available as a docker image. This image expects:

  • the configuration file mounted in /etc/Caddyfile

Without this configuration, it will fail to start