Skip to content
Documentation

Prelude · Documentation

Everything you need to
run Prelude.

Setup guides and the complete reference for the Prelude stack. Pick a product below and go straight to what you need.

The Prelude Suite

Browse the library

One entry per product. Pick a version, and you'll land on its current release documentation by default.

  1. Prelude Collector

    Vendor-agnostic network telemetry collector.

  2. Prelude Topology Engine

    BGP-LS topology collector with SR-MPLS, SRv6, and Flex-Algo support.

Get Started

Quick Start

Run Prelude on your own infrastructure in minutes. Pick a product, copy the commands, and open its full installation guide when you want the details.

Stand up the Collector with Docker Compose

The Collector runs alongside Postgres and NATS. Drop in the compose file and start collecting. Everything is configured through environment variables.

URL
https://your-host:4030
User
admin
Password
@rolo!Pass246

Change the password on first login.

Read the full installation guide
docker-compose.yml
# docker-compose.yml — collector + postgres + nats
# then: docker compose up -d  →  https://localhost:4030 (admin / @rolo!Pass246)
services:
  collector:
    image: registry.arolo-solutions.com/prelude/prelude-collector:latest
    ports: ["4030:4030"]
    environment:
      COLLECTOR_DB_HOST: postgres
      COLLECTOR_DB_USER: prelude
      COLLECTOR_DB_NAME: collector
      COLLECTOR_DB_PASSWORD: ${POSTGRES_PASSWORD:-change-me-sE43kapqD8df5fds}
      COLLECTOR_APP_URL: http://localhost:4030
    volumes: [collector-data:/app/storage]
    depends_on: [postgres, nats]
    restart: unless-stopped

  postgres:
    image: postgres:18.4-alpine
    environment:
      POSTGRES_USER: prelude
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-change-me-sE43kapqD8df5fds}
      POSTGRES_DB: collector
    volumes: [postgres-data:/var/lib/postgresql/data]

  nats:
    image: nats:2

volumes:
  collector-data:
  postgres-data:

Run Prelude TE in under two minutes

One self-contained container, zero dependencies. Pull the image, start it, and the web UI is live on your machine.

URL
https://your-host
User
admin
Password
@rolo!Pass246

Change the password on first login.

Read the full installation guide
docker-compose.yml
# docker-compose.yml — then: docker compose up -d
services:
  prelude-te:
    image: registry.arolo-solutions.com/prelude/prelude-te:latest
    ports:
      - "443:4040"
      - "179:179"
    volumes:
      - te_storage:/app/storage
    restart: unless-stopped

volumes:
  te_storage: