Getting Started with Sequin

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.

Create directory and start services

Download sequin-docker-compose.zip.
Unzip the file.
Navigate to the unzipped directory and start the services:

cd sequin-docker-compose && docker compose up -d

Alternative: Download with curl

curl -L https://github.com/sequinstream/sequin/releases/latest/download/sequin-docker-compose.zip -o sequin-docker-compose.zip \
  && unzip sequin-docker-compose.zip && rm sequin-docker-compose.zip
cd sequin-docker-compose && docker compose up -d

Alternative: Clone the repository

git clone git@github.com:sequinstream/sequin.git
cd sequin/docker
docker compose up -d

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).

Open your browser and navigate to http://localhost:7376.Sign in with the default credentials:

Username: admin@sequinstream.com
Password: sequinpassword!

Create a sink

You’re in! Create a sink by following one of our quickstart guides:

Webhooks

Get started with real-time updates via webhooks.

Kafka

Set up CDC streaming with Apache Kafka.

Typesense

Stream changes to Typesense.

Meilisearch

Stream changes to Meilisearch.

Elasticsearch

Stream changes to Elasticsearch.

Redis Stream

Stream changes using Redis pub/sub.

RabbitMQ

Get started with RabbitMQ messaging.

NATS

Stream changes using NATS messaging.

Redpanda

Set up CDC with Redpanda streaming.

Azure Event Hubs

Stream changes using Azure Event Hubs.

GCP Pub/Sub

Get started with Google Cloud Pub/Sub.

AWS SQS

Stream changes using AWS Simple Queue Service.

Sequin Stream

Use Sequin’s native streaming protocol.

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:

Remove the postgres service section
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:

Remove the redis service section
Update the Sequin service configuration:

services:
  sequin:
    environment:
      - REDIS_URL=<url>

Adding to an existing project

Using Docker Compose include (recommended)

The cleanest way to add Sequin to an existing project is using Docker Compose’s include functionality:

Download the Sequin’s docker-compose.yaml.
Add an include section to your existing docker-compose.yaml:

include:
  - sequin-docker-compose.yaml

services:
  # your existing services...

This approach keeps your main compose file clean while providing all of Sequin’s services.

Adding Sequin service directly

Alternatively, you can add Sequin directly to your existing Docker Compose file by adding 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. For production deployment on AWS using Terraform, see the deployment directory which contains infrastructure-as-code templates for deploying Sequin on AWS ECS.

Get started

Sink setup guides

How-to guides

Concepts

Reference

Database setup guides

Tutorials

Getting Started with Sequin

Prerequisites

Quick start

Webhooks

Kafka

Typesense

Meilisearch

Elasticsearch

Redis Stream

RabbitMQ

NATS

Redpanda

Azure Event Hubs

GCP Pub/Sub

AWS SQS

Sequin Stream

Using your own database

Using existing Postgres

Using existing Redis

Adding to an existing project

Using Docker Compose include (recommended)

Adding Sequin service directly

Preparing for production

​Prerequisites

​Quick start

Webhooks

Kafka

Typesense

Meilisearch

Elasticsearch

Redis Stream

RabbitMQ

NATS

Redpanda

Azure Event Hubs

GCP Pub/Sub

AWS SQS

Sequin Stream

​Using your own database

​Using existing Postgres

​Using existing Redis

​Adding to an existing project

​Using Docker Compose include (recommended)

​Adding Sequin service directly

​Preparing for production

Prerequisites

Quick start

Using your own database

Using existing Postgres

Using existing Redis

Adding to an existing project

Using Docker Compose include (recommended)

Adding Sequin service directly

Preparing for production