You can start running Sequin quickly with Docker Compose.

​
Prerequisites

You’ll need Docker and Docker Compose installed.

​
Quick start

The easiest way to get started with Sequin is with our Docker Compose file. This file starts a Postgres database, Redis instance, and Sequin server.

1

Create directory and start services

  1. Download sequin-docker-compose.zip.
  2. Unzip the file.
  3. Navigate to the unzipped directory and start the services:
cd sequin-docker-compose && docker compose up -d
2

Verify services are running

Check that Sequin is running using docker ps:

docker ps

You should see output like the following:

CONTAINER ID   IMAGE                           COMMAND                  CREATED          STATUS                    PORTS                              NAMES
bd5c458cabde   sequin/sequin:latest            "/scripts/start_comm…"   11 seconds ago   Up 9 seconds              4000/tcp, 0.0.0.0:7376->7376/tcp   sequin-sequin-1
3bacd89765e7   grafana/grafana                 "/run.sh"                11 seconds ago   Up 11 seconds             0.0.0.0:3000->3000/tcp             sequin-sequin_grafana-1
3ad41319a66c   postgres:16                     "docker-entrypoint.s…"   11 seconds ago   Up 11 seconds (healthy)   0.0.0.0:7377->5432/tcp             sequin-sequin_postgres-1
6139a5fc4e80   redis:7                         "docker-entrypoint.s…"   11 seconds ago   Up 11 seconds             0.0.0.0:7378->6379/tcp             sequin-sequin_redis-1
7e07a5b052de   prom/prometheus                 "/bin/prometheus --c…"   11 seconds ago   Up 11 seconds             0.0.0.0:9090->9090/tcp             sequin-sequin_prometheus-1

Sequin, Postgres, Redis, Prometheus, and Grafana should be up and running (status: Up).

3

Login to Sequin

Open your browser and navigate to http://localhost:7376.

Sign in with the default credentials:

  • Username: admin@sequinstream.com
  • Password: sequinpassword!
4

Create a sink

5

View metrics in Grafana

Sequin exports various metrics in Prometheus format.

Using the Grafana service from Docker Compose, you can view our example dashboard here.

Sign in with Grafana’s default credentials:

  • Username: admin
  • Password: admin

​
Using your own database

​
Using existing Postgres

Sequin uses a Postgres database for configuration and to assist with its change data capture process.

These PG_* variables configure Sequin’s internal Postgres database. The Postgres databases you want to stream from are configured separately in sequin.yaml.

We recommend creating a new logical database for Sequin in your existing Postgres instance:

create database {DB-NAME};

Then, modify your docker-compose.yaml:

  1. Remove the postgres service section
  2. Update the Sequin service configuration:
services:
  sequin:
    environment:
      - PG_PORT=<port>
      - PG_HOSTNAME=<hostname>
      - PG_DATABASE=<database>
      - PG_USERNAME=<username>
      - PG_PASSWORD=<password>

​
Using existing Redis

Sequin uses Redis to assist with its change data capture process.

If you have an existing Redis instance:

  1. Remove the redis service section
  2. Update the Sequin service configuration:
services:
  sequin:
    environment:
      - REDIS_URL=<url>

​
Adding to an existing project

To add Sequin to an existing project’s Docker Compose file, add a sequin service:

services:
  ...
  sequin:
    image: sequin/sequin:latest
    ports:
      - "7376:7376"
    environment:
      - PG_PORT=<port>
      - PG_HOSTNAME=postgres
      - PG_DATABASE=sequin
      - PG_USERNAME=postgres
      - PG_PASSWORD=postgres
      - REDIS_URL=<url>
      - SECRET_KEY_BASE=wDPLYus0pvD6qJhKJICO4dauYPXfO/Yl782Zjtpew5qRBDp7CZvbWtQmY0eB13If
      - VAULT_KEY=2Sig69bIpuSm2kv0VQfDekET2qy8qUZGI8v3/h3ASiY=
    depends_on:
      - postgres
      - redis

​
Preparing for production

For more configuration options and steps for deploying to production, see the Configuration Reference.