Getting Started with Sequin
Get Sequin running in a few minutes
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:
Verify services are running
Check that Sequin is running using docker ps
:
You should see output like the following:
All three containers should be up and running (status: Up
).
Login to Sequin
Open your browser and navigate to http://localhost:7376
.
Sign in with the default credentials:
- Username:
admin@sequinstream.com
- Password:
sequinpassword!
Create a sync
You’re in! Create a sync by following one of our quickstart guides:
Webhooks
Get started with real-time updates via webhooks.
Kafka
Set up CDC streaming with Apache Kafka.
Redis
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.
Using your own database
Using existing Postgres
Sequin uses a Postgres database for configuration and to assist with its change data capture process.
If you have an existing Postgres database you want Sequin to use for config, modify your docker-compose.yaml
:
- Remove the
postgres
service section - Update the Sequin service configuration:
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:
Adding to an existing project
To add Sequin to an existing project’s Docker Compose file, add a sequin
service:
Preparing for production
For more configuration options and steps for deploying to production, see the Configuration Reference.
Was this page helpful?