Admin Guide

All you need to know about setting up, running, and using Horizon.

📄️ Overview

Horizon is a central component of the Stellar platform: it provides an HTTP API to data in the Stellar network. It ingests and re-serves the data produced by the Stellar network in a form that is easier to consume by the average application relative to the performance-oriented data representations used by Stellar Core.

📄️ Prerequisites

The Horizon service is responsible for synchronizing with the Stellar network and processing ledger data. To understand the scope of Horizon's services, please read the configuring section before you move on to the prerequisites for computation.

📄️ Installing

To install Horizon in production or non-development environments, we recommend the following based on target infrastructure:

📄️ Configuring

Prerequisites

📄️ Running

Once you have established the Horizon database and have identified the Horizon runtime config per host, you're ready to run Horizon.

📄️ Ingestion

Horizon API provides most of its utility through ingested data, and your Horizon server can be configured to listen for and ingest transaction results from the Stellar network. Ingestion enables API access to both current state (e.g. someone's balance) and historical state (e.g. someone's transaction history).

📄️ Monitoring

Metrics

📄️ Scaling

As alluded to in the discussion in Prerequisites, Horizon encompasses different logical tiers that can be scaled independently for high throughput, isolation, and high availability. The following components can be independently scaled:

📄️ Upgrading

Here we'll describe the recommended steps for upgrading a Horizon 2.x installation.

📄️ Ingestion Filtering

Overview