Reference for Sequin configuration options. Explore advanced settings for clustering, memory management, and authentication.
SERVER_PORT
: Server port number (default: 7376)
SERVER_HOST
: Host name for the server
SERVER_CHECK_ORIGIN
: Enable origin checking (default: false
)
true
and set SERVER_HOST
to your public domain. This will ensure that Sequin only serves requests from origins matching SERVER_HOST
. e.g. if your app is hosted at https://sequin.example.com
, you should set SERVER_HOST
to sequin.example.com
and SERVER_CHECK_ORIGIN
to true
.LOG_LEVEL
: Sets application logging verbosity (default: info
)
error
, warning
, notice
, info
, debug
SEQUIN_LOG_FORMAT
: Sets the log format (default: console
)
console
outputs logs to the console in a human-readable format.datadog_json
outputs logs in JSON format, which is compatible with Datadog’s logging format.CONFIG_FILE_PATH
: Path to configuration fileCONFIG_FILE_YAML
: YAML configuration content (base64 encoded)
sequin.yaml
). It is recommended to give Sequin its own logical database, though it may reside on the same physical Postgres database as your source databases.
PG_URL
: Complete Postgres connection URL (alternative to individual PG_* variables below)
postgres://sequin:password@localhost:5432/sequin
)PG_PORT
: Postgres port number (default: 5432)PG_HOSTNAME
: Postgres host addressPG_DATABASE
: Database namePG_USERNAME
: Database userPG_PASSWORD
: Database passwordPG_IPV6
: Enable IPv6 support (default: false)PG_SSL
: Enable SSL for Postgres connection (default: false)PG_POOL_SIZE
: Database connection pool size (default: 10)PG_POOL_SIZE
PG_POOL_SIZE
variable controls the maximum number of concurrent connections that Sequin will maintain to Postgres. For higher throughput on larger Postgres instances, you should increase this value.
DEFAULT_WORKERS_PER_SINK
: Sets a global default for the number of concurrent workers to assign to each sink. If not set, Sequin will use a default based on the number of CPU cores. You may want to set higher if you have high-latency destinations, like slow webhook endpoints. Must be an integer >= 1.BACKFILL_MAX_PENDING_MESSAGES
: When backfilling, the maximum number of pending messages to accumulate in the sink’s outbox before pausing the backfill. When messages start draining to the sink, the backfill will automatically resume. The default is 1M messages.MAX_MEMORY_MB
: Maximum memory limit in megabytes
2048
for 2GB limitMEMORY_BUFFER_PERCENT
: Percentage of memory to reserve as buffer (default: 20)
20
reserves 20% as buffer, using 80% of available memoryMAX_MEMORY_MB
.REDIS_URL
: Redis connection URL (required)
redis://localhost:6379
or rediss://localhost:6379
rediss://
automatically enables SSL/TLSredis://localhost:6379/1
will connect to Redis database 1redis://username:password@localhost:6379
will authenticate as username
default
if you are not using redis usersREDIS_TLS
: Enable SSL/TLS for Redis connection (optional)
"true"
, "1"
REDIS_IPV6
: Enable IPv6 support (optional)
"true"
or "1"
to enableREDIS_POOL_SIZE
: Number of Redis connections in the pool (optional)
REDIS_TLS_CA_CERT_FILE
: Path to CA certificate file for server verificationREDIS_TLS_CLIENT_CERT_FILE
: Path to client certificate file (for mTLS)
REDIS_TLS_CLIENT_KEY_FILE
REDIS_TLS_CLIENT_KEY_FILE
: Path to client private key file (for mTLS)
REDIS_TLS_CLIENT_CERT_FILE
REDIS_TLS_VERIFY
: Certificate verification mode (optional)
"verify_peer"
, "verify_none"
"verify_peer"
when certificate files are provided, "verify_none"
otherwiseSECRET_KEY_BASE
: Base secret key for encryptionVAULT_KEY
: Vault encryption keyFEATURE_ACCOUNT_SELF_SIGNUP
: Enable account self-signup (default: enabled)
FEATURE_PROVISION_DEFAULT_USER
: Enable default user provisioning (default: enabled)
SEQUIN_TELEMETRY_DISABLED
: Disable telemetry data collection (default: false)
true
.CRASH_REPORTING_DISABLED
: Disable crash reporting (default: false)
true
.LONG_POLL_FALLBACK_MS
: Long poll fallback time in milliseconds (default: 3000)
GITHUB_CLIENT_ID
: GitHub OAuth client IDGITHUB_CLIENT_SECRET
: GitHub OAuth client secretGITHUB_CLIENT_REDIRECT_URI
: GitHub OAuth callback URL, including the path /auth/github/callback
https://console.sequinstream.com/auth/github/callback
SEQUIN_METRICS_PORT
: Port number for the metrics endpoint (default: 8376)
/metrics
on this port.SEQUIN_METRICS_USER
: Username required to access the metrics endpoint (optional)
SEQUIN_METRICS_PASSWORD
: Password required to access the metrics endpoint (optional)
If either variable is set, Sequin secures the /metrics
endpoint with HTTP Basic Authentication. With both unset, the endpoint is publicly accessible (recommended only for local development).
REPLICATION_FLUSH_MAX_ACCUMULATED_BYTES
: Maximum number of bytes to accumulate in memory before flushing the replication batch downstream. (Default: 100MB)REPLICATION_FLUSH_MAX_ACCUMULATED_MESSAGES
: Maximum number of messages to accumulate before flushing. (Default: 100,000)REPLICATION_FLUSH_MAX_ACCUMULATED_TIME_MS
: Maximum time (in milliseconds) to wait before flushing accumulated messages, even if neither of the above thresholds is reached. (Default: 50ms)SECRET_KEY_BASE
and VAULT_KEY
:
SERVER_CHECK_ORIGIN
and SERVER_HOST
SERVER_CHECK_ORIGIN
to true
and SERVER_HOST
to your public domain. See General configuration.