Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 2.8 KB

quickstart.md

File metadata and controls

42 lines (30 loc) · 2.8 KB
Raw
title replacement
Horizon Quickstart

Horizon Quickstart

This document describes how to quickly set up a test Stellar Core + Horizon node, that you can play around with to get a feel for how a stellar node operates. This configuration is not secure! It is not intended as a guide for production administration.

For detailed information about running Horizon and Stellar Core safely in production see the Horizon Administration Guide and the Stellar Core Administration Guide.

If you're ready to roll up your sleeves and dig into the code, check out the Developer Guide.

Install and run the Quickstart Docker Image

The fastest way to get up and running is using the Stellar Quickstart Docker Image. This is a Docker container that provides both stellar-core and horizon, pre-configured for testing.

  1. Install Docker.
  2. Verify your Docker installation works: docker run hello-world
  3. Create a local directory that the container can use to record state. This is helpful because it can take a few minutes to sync a new stellar-core with enough data for testing, and because it allows you to inspect and modify the configuration if needed. Here, we create a directory called stellar to use as the persistent volume: cd $HOME; mkdir stellar
  4. Download and run the Stellar Quickstart container, replacing USER with your username:
docker run --rm -it -p "8000:8000" -p "11626:11626" -p "11625:11625" -p"8002:5432" -v $HOME/stellar:/opt/stellar --name stellar stellar/quickstart --testnet

You can check out Stellar Core status by browsing to http://localhost:11626.

You can check out your Horizon instance by browsing to http://localhost:8000.

You can tail logs within the container to see what's going on behind the scenes:

docker exec -it stellar /bin/bash
supervisorctl tail -f stellar-core
supervisorctl tail -f horizon stderr

On a modern laptop this test setup takes about 15 minutes to synchronise with the last couple of days of testnet ledgers. At that point Horizon will be available for querying.

See the Quickstart Docker Image documentation for more details, and alternative ways to run the container.

You can test your Horizon instance with a query like: http://localhost:8000/transactions?cursor=&limit=10&order=asc. Use the Stellar Laboratory to craft other queries to try out, and read about the available endpoints and see examples in the Horizon API reference.