Sockudo
Reference

Environment variables

Complete Sockudo runtime environment variable reference.

Sockudo loads configuration from files first, then applies environment variable overrides. Values are parsed as strings unless the target option is numeric or boolean. Boolean values follow the server parser and accept common true/false forms.

This page lists every runtime environment variable referenced by the server, core configuration loader, push subsystem, app managers, adapters, queues, and provider workers.

Process and listener

VariablePurpose
ENVIRONMENTRuntime mode label.
DEBUGForces debug mode on when truthy.
DEBUG_MODEOverrides the configured debug flag.
HOSTMain HTTP and WebSocket bind host.
PORTMain HTTP and WebSocket bind port.
ACTIVITY_TIMEOUTPusher protocol activity timeout.
SHUTDOWN_GRACE_PERIODGrace period for server shutdown.
USER_AUTHENTICATION_TIMEOUTTimeout used by user authentication flows.
WEBSOCKET_MAX_PAYLOAD_KBLegacy maximum WebSocket payload size in KiB.
INSTANCE_PROCESS_IDStable node/process identity used by clustering and Iggy consumers.
HOSTNAMEFallback node identity for Iggy when INSTANCE_PROCESS_ID is not set.
HEALTH_CHECK_TIMEOUT_MSDependency timeout for health checks.
HTTP_API_USAGE_ENABLEDEnables /usage and /stats operational endpoints.

Logging

VariablePurpose
SOCKUDO_LOG_DEBUGDefault log filter when debug mode is active.
SOCKUDO_LOG_PRODDefault log filter when debug mode is not active.
LOG_OUTPUT_FORMATSet to json for JSON logs.
LOG_COLORS_ENABLEDEnables or disables colored text logs.
LOG_INCLUDE_TARGETIncludes tracing targets in text logs.

Driver selection

VariablePurpose
ADAPTER_DRIVERHorizontal fanout driver.
CACHE_DRIVERCache driver.
QUEUE_DRIVERQueue driver.
APP_MANAGER_DRIVERApp manager driver.
RATE_LIMITER_DRIVERRate limiter backend driver.
ADAPTER_BUFFER_MULTIPLIER_PER_CPUAdapter fanout buffer sizing multiplier.
ADAPTER_ENABLE_SOCKET_COUNTINGEnables adapter socket counting.
ADAPTER_FALLBACK_TO_LOCALFalls back to the local adapter when a configured adapter cannot start.
APP_MANAGER_REGISTER_INLINE_APPSAllows inline app definitions from config to be registered.
SOCKUDO_SKIP_INLINE_APPSSkips inline apps even if present in the config file.

Default app bootstrap

VariablePurpose
SOCKUDO_DEFAULT_APP_IDDefault app ID created from environment.
SOCKUDO_DEFAULT_APP_KEYDefault app key created from environment.
SOCKUDO_DEFAULT_APP_SECRETDefault app secret created from environment.
SOCKUDO_DEFAULT_APP_ENABLEDEnables or disables default app registration.
SOCKUDO_DEFAULT_APP_MAX_CONNECTIONSDefault app connection limit.
SOCKUDO_DEFAULT_APP_MAX_BACKEND_EVENTS_PER_SECONDDefault app backend publish rate limit.
SOCKUDO_DEFAULT_APP_MAX_CLIENT_EVENTS_PER_SECONDDefault app client event rate limit.
SOCKUDO_DEFAULT_APP_MAX_READ_REQUESTS_PER_SECONDDefault app read API rate limit.
SOCKUDO_DEFAULT_APP_MAX_PRESENCE_MEMBERS_PER_CHANNELDefault app presence member limit per channel.
SOCKUDO_DEFAULT_APP_MAX_PRESENCE_MEMBER_SIZE_IN_KBDefault app presence member payload size limit.
SOCKUDO_DEFAULT_APP_MAX_CHANNEL_NAME_LENGTHDefault app channel name length limit.
SOCKUDO_DEFAULT_APP_MAX_EVENT_CHANNELS_AT_ONCEDefault app maximum fanout channels per event.
SOCKUDO_DEFAULT_APP_MAX_EVENT_NAME_LENGTHDefault app event name length limit.
SOCKUDO_DEFAULT_APP_MAX_EVENT_PAYLOAD_IN_KBDefault app event payload size limit.
SOCKUDO_DEFAULT_APP_MAX_EVENT_BATCH_SIZEDefault app batch publish item limit.
SOCKUDO_DEFAULT_APP_ENABLE_CLIENT_MESSAGESEnables client events for the default app.
SOCKUDO_ENABLE_CLIENT_MESSAGESLegacy fallback for default app client events.
SOCKUDO_DEFAULT_APP_ENABLE_USER_AUTHENTICATIONEnables user authentication features for the default app.
SOCKUDO_DEFAULT_APP_ENABLE_WATCHLIST_EVENTSEnables watchlist events for the default app.
SOCKUDO_DEFAULT_APP_ALLOWED_ORIGINSComma-separated origin allowlist for the default app.
SOCKUDO_DEFAULT_APP_ANNOTATIONS_ENABLEDEnables annotations for the default app channel policy.

Redis

VariablePurpose
REDIS_URLShared Redis URL override for adapter, cache, queue, and rate limiter Redis clients.
DATABASE_REDIS_HOSTRedis host.
DATABASE_REDIS_PORTRedis port.
DATABASE_REDIS_USERNAMERedis username.
DATABASE_REDIS_PASSWORDRedis password.
DATABASE_REDIS_DBRedis database index.
DATABASE_REDIS_KEY_PREFIXRedis key prefix.
DATABASE_REDIS_CLUSTER_NODESComma-separated Redis Cluster seed nodes.
REDIS_CLUSTER_NODESComma-separated Redis Cluster seed nodes, also applied to adapter and queue cluster config.
DATABASE_REDIS_CLUSTER_USERNAMERedis Cluster username.
DATABASE_REDIS_CLUSTER_PASSWORDRedis Cluster password.
DATABASE_REDIS_CLUSTER_USE_TLSEnables TLS for Redis Cluster.
REDIS_CLUSTER_QUEUE_CONCURRENCYRedis Cluster queue worker concurrency.
REDIS_CLUSTER_QUEUE_PREFIXRedis Cluster queue key prefix.

SQL and app storage

VariablePurpose
DATABASE_MYSQL_HOSTMySQL host.
DATABASE_MYSQL_PORTMySQL port.
DATABASE_MYSQL_USERNAMEMySQL username.
DATABASE_MYSQL_PASSWORDMySQL password.
DATABASE_MYSQL_DATABASEMySQL database name.
DATABASE_MYSQL_TABLE_NAMEMySQL app table name.
DATABASE_MYSQL_POOL_MINMySQL minimum pool size.
DATABASE_MYSQL_POOL_MAXMySQL maximum pool size.
DATABASE_POSTGRES_HOSTPostgreSQL host.
DATABASE_POSTGRES_PORTPostgreSQL port.
DATABASE_POSTGRES_USERNAMEPostgreSQL username used by the core config loader.
DATABASE_POSTGRES_USERPostgreSQL username fallback used by the PostgreSQL app manager.
DATABASE_POSTGRES_PASSWORDPostgreSQL password.
DATABASE_POSTGRES_DATABASEPostgreSQL database name.
DATABASE_POSTGRES_POOL_MINPostgreSQL minimum pool size.
DATABASE_POSTGRES_POOL_MAXPostgreSQL maximum pool size.
DATABASE_POOLING_ENABLEDEnables database pooling.
DATABASE_POOL_MINGlobal minimum pool size.
DATABASE_POOL_MAXGlobal maximum pool size.
DATABASE_CONNECTION_POOL_SIZEGlobal connection pool size applied to MySQL and PostgreSQL.

DynamoDB, SurrealDB, and ScyllaDB

VariablePurpose
DATABASE_DYNAMODB_REGIONDynamoDB region.
DATABASE_DYNAMODB_TABLE_NAMEDynamoDB table name.
DATABASE_DYNAMODB_ENDPOINT_URLDynamoDB custom endpoint URL.
AWS_ACCESS_KEY_IDAWS access key used by DynamoDB and AWS-backed queues.
AWS_SECRET_ACCESS_KEYAWS secret key used by DynamoDB and AWS-backed queues.
DATABASE_SURREALDB_URLSurrealDB connection URL.
DATABASE_SURREALDB_NAMESPACESurrealDB namespace.
DATABASE_SURREALDB_DATABASESurrealDB database.
DATABASE_SURREALDB_USERNAMESurrealDB username.
DATABASE_SURREALDB_PASSWORDSurrealDB password.
DATABASE_SURREALDB_TABLE_NAMESurrealDB app table name.
SCYLLADB_NODESComma-separated ScyllaDB nodes.
SCYLLADB_KEYSPACEScyllaDB keyspace.
SCYLLADB_REPLICATION_CLASSScyllaDB replication class.
SCYLLADB_REPLICATION_FACTORScyllaDB replication factor.

Cache

VariablePurpose
CACHE_TTL_SECONDSCache TTL applied to app, channel, database, and memory cache settings.
CACHE_CLEANUP_INTERVALCache cleanup interval for in-memory and database cache paths.
CACHE_MAX_CAPACITYCache maximum capacity for supported cache stores.

TLS, Unix sockets, and CORS

VariablePurpose
SSL_ENABLEDEnables TLS listener mode.
SSL_CERT_PATHTLS certificate path.
SSL_KEY_PATHTLS private key path.
SSL_REDIRECT_HTTPEnables HTTP-to-HTTPS redirect support.
SSL_HTTP_PORTHTTP redirect listener port.
UNIX_SOCKET_ENABLEDEnables Unix socket listener mode.
UNIX_SOCKET_PATHUnix socket filesystem path.
UNIX_SOCKET_PERMISSION_MODEUnix socket permission mode in octal.
CORS_ORIGINSComma-separated CORS origin patterns.
CORS_METHODSComma-separated CORS methods.
CORS_HEADERSComma-separated allowed headers.
CORS_CREDENTIALSEnables CORS credentials.

Metrics and rate limiting

VariablePurpose
METRICS_DRIVERMetrics backend driver.
METRICS_ENABLEDEnables the metrics server.
METRICS_HOSTMetrics bind host.
METRICS_PORTMetrics bind port.
METRICS_PROMETHEUS_PREFIXPrefix for Prometheus metric names.
METRICS_TCP_EXPORTER_ENABLEDEnables the metrics-rs TCP event exporter.
METRICS_TCP_EXPORTER_HOSTTCP exporter bind host.
METRICS_TCP_EXPORTER_PORTTCP exporter bind port.
METRICS_TCP_EXPORTER_BUFFER_SIZETCP exporter internal and per-client buffer size.
RATE_LIMITER_ENABLEDEnables HTTP and WebSocket rate limiting.
RATE_LIMITER_API_MAX_REQUESTSAPI requests allowed per rate limit window.
RATE_LIMITER_API_WINDOW_SECONDSAPI rate limit window length.
RATE_LIMITER_API_TRUST_HOPSTrusted proxy hops for API client IP extraction.
RATE_LIMITER_WS_MAX_REQUESTSWebSocket upgrade attempts allowed per window.
RATE_LIMITER_WS_WINDOW_SECONDSWebSocket rate limit window length.
RATE_LIMITER_WS_TRUST_HOPSTrusted proxy hops for WebSocket client IP extraction.
RATE_LIMITER_REDIS_PREFIXRedis key prefix for rate limiter state.

Queue backends

VariablePurpose
QUEUE_REDIS_CONCURRENCYRedis queue worker concurrency.
QUEUE_REDIS_PREFIXRedis queue key prefix.
QUEUE_SQS_REGIONSQS region.
QUEUE_SQS_VISIBILITY_TIMEOUTSQS visibility timeout.
QUEUE_SQS_MAX_MESSAGESSQS receive batch size.
QUEUE_SQS_WAIT_TIME_SECONDSSQS long-poll wait time.
QUEUE_SQS_CONCURRENCYSQS worker concurrency.
QUEUE_SQS_FIFOEnables FIFO queue behavior.
QUEUE_SQS_ENDPOINT_URLSQS custom endpoint URL.
QUEUE_SNS_REGIONSNS region.
QUEUE_SNS_TOPIC_ARNSNS topic ARN.
QUEUE_SNS_ENDPOINT_URLSNS custom endpoint URL.

NATS, Pulsar, RabbitMQ, Pub/Sub, Kafka, and Iggy

VariablePurpose
NATS_SERVERSComma-separated NATS server URLs.
NATS_USERNAMENATS username.
NATS_PASSWORDNATS password.
NATS_TOKENNATS token.
NATS_PREFIXNATS subject prefix.
NATS_CONNECTION_TIMEOUT_MSNATS connection timeout.
NATS_REQUEST_TIMEOUT_MSNATS request timeout.
NATS_DISCOVERY_MAX_WAIT_MSNATS node discovery maximum wait.
NATS_DISCOVERY_IDLE_WAIT_MSNATS node discovery idle wait.
NATS_NODES_NUMBERExpected NATS node count.
NATS_SUBSCRIPTION_CAPACITYNATS subscription channel capacity.
NATS_CLIENT_CAPACITYNATS client channel capacity.
NATS_MAX_RECONNECTSNATS reconnect limit.
NATS_PRESENCE_SYNC_CHUNK_SIZEPresence sync chunk size for NATS.
PULSAR_URLPulsar service URL.
PULSAR_PREFIXPulsar topic prefix.
PULSAR_TOKENPulsar auth token.
PULSAR_REQUEST_TIMEOUT_MSPulsar request timeout.
PULSAR_NODES_NUMBERExpected Pulsar node count.
RABBITMQ_URLRabbitMQ connection URL.
RABBITMQ_PREFIXRabbitMQ exchange or routing prefix.
RABBITMQ_CONNECTION_TIMEOUT_MSRabbitMQ connection timeout.
RABBITMQ_REQUEST_TIMEOUT_MSRabbitMQ request timeout.
RABBITMQ_NODES_NUMBERExpected RabbitMQ node count.
GOOGLE_PUBSUB_PROJECT_IDGoogle Pub/Sub project ID.
GOOGLE_PUBSUB_PREFIXGoogle Pub/Sub topic prefix.
PUBSUB_EMULATOR_HOSTPub/Sub emulator host.
GOOGLE_PUBSUB_REQUEST_TIMEOUT_MSGoogle Pub/Sub request timeout.
GOOGLE_PUBSUB_NODES_NUMBERExpected Pub/Sub node count.
KAFKA_BROKERSComma-separated Kafka brokers.
KAFKA_PREFIXKafka topic prefix.
KAFKA_SECURITY_PROTOCOLKafka security protocol.
KAFKA_SASL_MECHANISMKafka SASL mechanism.
KAFKA_SASL_USERNAMEKafka SASL username.
KAFKA_SASL_PASSWORDKafka SASL password.
KAFKA_REQUEST_TIMEOUT_MSKafka request timeout.
KAFKA_NODES_NUMBERExpected Kafka node count.
IGGY_CONNECTION_STRINGApache Iggy connection string.
IGGY_USERNAMEApache Iggy username.
IGGY_PASSWORDApache Iggy password.
IGGY_CONSUMER_NAMEApache Iggy consumer name.
IGGY_STREAMApache Iggy stream name.
IGGY_TOPIC_PREFIXApache Iggy adapter topic prefix.
IGGY_QUEUE_TOPIC_PREFIXApache Iggy queue topic prefix.
IGGY_CONSUMER_GROUP_PREFIXApache Iggy consumer group prefix.
IGGY_REQUEST_TIMEOUT_MSApache Iggy request timeout.
IGGY_POLL_INTERVAL_MSApache Iggy poll interval.
IGGY_POLL_BATCH_SIZEApache Iggy poll batch size.
IGGY_PARTITIONS_COUNTShared Apache Iggy partition count.
ADAPTER_IGGY_PARTITIONS_COUNTAdapter-specific Apache Iggy partition count.
QUEUE_IGGY_PARTITIONS_COUNTQueue-specific Apache Iggy partition count.
IGGY_PARTITION_IDShared Apache Iggy partition ID.
ADAPTER_IGGY_PARTITION_IDAdapter-specific Apache Iggy partition ID.
QUEUE_IGGY_PARTITION_IDQueue-specific Apache Iggy partition ID.
IGGY_AUTO_CREATEAuto-create Apache Iggy streams and topics.
IGGY_START_FROM_LATESTStart adapter consumption from latest messages.
IGGY_NODES_NUMBERExpected Apache Iggy node count.

Cleanup and cluster health

VariablePurpose
CLEANUP_ASYNC_ENABLEDEnables asynchronous cleanup.
CLEANUP_FALLBACK_TO_SYNCFalls back to synchronous cleanup when async cleanup fails.
CLEANUP_QUEUE_BUFFER_SIZECleanup queue buffer size.
CLEANUP_BATCH_SIZECleanup batch size.
CLEANUP_BATCH_TIMEOUT_MSCleanup batch timeout.
CLEANUP_WORKER_THREADSCleanup worker count or auto.
CLEANUP_MAX_RETRY_ATTEMPTSCleanup retry limit.
CLUSTER_HEALTH_ENABLEDEnables cluster health tracking.
CLUSTER_HEALTH_HEARTBEAT_INTERVALCluster heartbeat interval.
CLUSTER_HEALTH_NODE_TIMEOUTNode timeout before a peer is considered stale.
CLUSTER_HEALTH_CLEANUP_INTERVALCleanup interval for cluster health state.

WebSocket and Protocol V2 features

VariablePurpose
TAG_FILTERING_ENABLEDEnables Protocol V2 tag filtering.
WEBSOCKET_MAX_MESSAGESMaximum buffered outbound WebSocket messages, or none/0 for unlimited.
WEBSOCKET_MAX_BYTESMaximum buffered outbound WebSocket bytes, or none/0 for unlimited.
WEBSOCKET_DISCONNECT_ON_BUFFER_FULLDisconnects slow clients instead of dropping messages when buffers fill.
WEBSOCKET_MAX_MESSAGE_SIZEWebSocket message size limit.
WEBSOCKET_MAX_FRAME_SIZEWebSocket frame size limit.
WEBSOCKET_WRITE_BUFFER_SIZEWebSocket write buffer size.
WEBSOCKET_MAX_BACKPRESSUREWebSocket backpressure limit.
WEBSOCKET_AUTO_PINGEnables automatic WebSocket ping frames.
WEBSOCKET_PING_INTERVALWebSocket ping interval.
WEBSOCKET_IDLE_TIMEOUTWebSocket idle timeout.
WEBSOCKET_COMPRESSIONWebSocket compression mode.
CONNECTION_RECOVERY_ENABLEDEnables Protocol V2 connection recovery.
CONNECTION_RECOVERY_BUFFER_TTLRecovery buffer TTL.
CONNECTION_RECOVERY_MAX_BUFFER_SIZERecovery buffer maximum size.
EPHEMERAL_ENABLEDEnables ephemeral event handling.
ECHO_CONTROL_ENABLEDEnables per-connection echo control.
ECHO_CONTROL_DEFAULT_ECHO_MESSAGESDefault echo behavior when echo control is enabled.
EVENT_NAME_FILTERING_ENABLEDEnables event-name filtering for subscriptions.
EVENT_NAME_FILTERING_MAX_EVENTS_PER_FILTERMaximum event names in one subscription filter.
EVENT_NAME_FILTERING_MAX_EVENT_NAME_LENGTHMaximum event name length inside a filter.

History, idempotency, versioning, and annotations

VariablePurpose
HISTORY_ENABLEDEnables durable channel history.
HISTORY_REWIND_ENABLEDEnables rewind reads from history.
HISTORY_RETENTION_WINDOW_SECONDSDurable history retention window.
HISTORY_MAX_PAGE_SIZEMaximum history page size.
HISTORY_WRITER_SHARDSDurable history writer shard count.
HISTORY_WRITER_QUEUE_CAPACITYDurable history writer queue capacity.
HISTORY_BACKENDDurable history backend.
HISTORY_MAX_MESSAGES_PER_CHANNELOptional retained message count limit per channel.
HISTORY_MAX_BYTES_PER_CHANNELOptional retained byte limit per channel.
HISTORY_POSTGRES_TABLE_PREFIXPostgreSQL history table prefix.
HISTORY_POSTGRES_WRITE_TIMEOUT_MSPostgreSQL history write timeout.
HISTORY_PURGE_INTERVAL_SECONDSHistory purge interval.
HISTORY_PURGE_BATCH_SIZEHistory purge batch size.
HISTORY_MAX_PURGE_PER_TICKMaximum purged history rows per purge tick.
PRESENCE_HISTORY_ENABLEDEnables retained presence history.
PRESENCE_HISTORY_RETENTION_WINDOW_SECONDSPresence history retention window.
PRESENCE_HISTORY_MAX_PAGE_SIZEMaximum presence history page size.
PRESENCE_HISTORY_MAX_EVENTS_PER_CHANNELOptional retained presence event limit per channel.
PRESENCE_HISTORY_MAX_BYTES_PER_CHANNELOptional retained presence byte limit per channel.
IDEMPOTENCY_ENABLEDEnables HTTP publish idempotency.
IDEMPOTENCY_TTL_SECONDSIdempotency cache TTL.
IDEMPOTENCY_MAX_KEY_LENGTHMaximum idempotency key length.
VERSIONED_MESSAGES_ENABLEDEnables Protocol V2 mutable messages.
VERSIONED_MESSAGES_DRIVERVersioned message backend driver.
VERSIONED_MESSAGES_MAX_PAGE_SIZEMaximum versioned-message page size.
VERSIONED_MESSAGES_RETENTION_WINDOW_SECONDSVersioned-message retention window.
VERSIONED_MESSAGES_PURGE_INTERVAL_SECONDSVersioned-message purge interval.
VERSIONED_MESSAGES_PURGE_BATCH_SIZEVersioned-message purge batch size.
VERSIONED_MESSAGES_MAX_PURGE_PER_TICKMaximum versioned-message rows purged per tick.
ANNOTATIONS_ENABLEDEnables message annotations globally.

Webhooks

VariablePurpose
WEBHOOK_BATCHING_ENABLEDEnables webhook batching.
WEBHOOK_BATCHING_DURATIONWebhook batching duration.
WEBHOOK_BATCHING_SIZEWebhook batching size.

Push core

VariablePurpose
PUSH_STORAGE_DRIVERPush storage backend driver.
PUSH_QUEUE_DRIVERPush queue backend driver.
PUSH_CREDENTIAL_ENCRYPTION_KEYMaster key for encrypted push credential material.
PUSH_ACCEPTANCE_RATE_LIMITAdmission rate limit for push publish requests.
PUSH_ANALYTICS_ENABLEDEnables push analytics collection.
PUSH_FANOUT_FAST_THRESHOLDRecipient threshold for fast-path push fanout.
PUSH_FANOUT_SHARD_SIZERecipient shard size for large fanout.
PUSH_FANOUT_SYNC_THRESHOLDThreshold below which fanout can remain synchronous.
PUSH_BACKPRESSURE_LAG_THRESHOLD_SECSQueue lag threshold that marks push backpressure.
PUSH_BACKPRESSUREForces push backpressure responses in the HTTP layer.
PUSH_BACKPRESSURE_RETRY_AFTER_SECONDSRetry-After value emitted for push backpressure.
PUSH_PUBLISH_LOG_MAX_LAGMaximum publish-log lag tolerated before push backpressure.
PUSH_PUBLISH_STATUS_TTL_DAYSRetention for push publish status records.
PUSH_FAILURE_THRESHOLDPush circuit-breaker failure threshold.
PUSH_SCHEDULER_INTERVAL_SECSScheduled push scan interval.
PUSH_STALE_DEVICE_MAX_AGE_DAYSStale device age threshold.
PUSH_DEFAULT_ACCEPTANCE_RPSDefault per-app push acceptance RPS quota.
PUSH_DEFAULT_DELIVERY_QUOTA_DAILYDefault per-app daily delivery quota.
PUSH_DEFAULT_FANOUT_MAXDefault per-app maximum fanout.
PUSH_DEFAULT_INFLIGHT_MAXDefault per-app in-flight publish limit.
PUSH_FANOUT_MAXHTTP-layer fanout cap override.
PUSH_DELIVERY_QUOTA_DAILYHTTP-layer daily delivery quota override.

Push providers

VariablePurpose
PUSH_FCM_ENABLEDEnables FCM dispatch.
FCM_PROJECT_IDFCM project ID for monolith dispatch workers.
PUSH_FCM_PROJECT_IDFCM project ID alias.
FCM_SERVICE_ACCOUNT_JSON_PATHPath to FCM service account JSON for auto-refreshing OAuth tokens.
PUSH_FCM_SERVICE_ACCOUNT_JSON_PATHFCM service account JSON path alias.
FCM_SERVICE_ACCOUNT_JSONInline FCM service account JSON for auto-refreshing OAuth tokens.
PUSH_FCM_SERVICE_ACCOUNT_JSONInline FCM service account JSON alias.
FCM_APP_IDApp ID used to load stored FCM credentials.
PUSH_FCM_APP_IDStored FCM credential app ID alias.
FCM_CREDENTIAL_IDStored FCM credential ID.
PUSH_FCM_CREDENTIAL_IDStored FCM credential ID alias.
FCM_PROVIDER_TOKENLegacy static FCM OAuth token for short-lived dispatch.
PUSH_FCM_PROVIDER_TOKENLegacy static FCM token alias.
FCM_ENDPOINTFCM endpoint override.
PUSH_FCM_ENDPOINTFCM endpoint alias.
PUSH_APNS_ENABLEDEnables APNs dispatch.
APNS_TOPICAPNs topic or bundle ID.
PUSH_APNS_TOPICAPNs topic alias.
APNS_ENDPOINTAPNs endpoint override.
PUSH_APNS_ENDPOINTAPNs endpoint alias.
APNS_APP_IDApp ID used to load stored APNs credentials.
PUSH_APNS_APP_IDStored APNs app ID alias.
APNS_CREDENTIAL_IDStored APNs credential ID.
PUSH_APNS_CREDENTIAL_IDStored APNs credential ID alias.
APNS_PROVIDER_TOKENStatic APNs provider token.
PUSH_APNS_PROVIDER_TOKENStatic APNs provider token alias.
APNS_TEAM_IDAPNs token-auth team ID.
PUSH_APNS_TEAM_IDAPNs team ID alias.
APNS_KEY_IDAPNs token-auth key ID.
PUSH_APNS_KEY_IDAPNs key ID alias.
APNS_PRIVATE_KEYAPNs token-auth private key content.
PUSH_APNS_PRIVATE_KEYAPNs private key content alias.
APNS_PRIVATE_KEY_PATHFilesystem path to APNs token-auth private key.
PUSH_APNS_PRIVATE_KEY_PATHAPNs private key path alias.
PUSH_WEBPUSH_ENABLEDEnables Web Push dispatch.
VAPID_PRIVATE_KEYWeb Push VAPID private key.
PUSH_WEBPUSH_VAPID_PRIVATE_KEYWeb Push VAPID private key alias.
VAPID_CONTACTWeb Push VAPID contact subject.
PUSH_WEBPUSH_VAPID_CONTACTWeb Push VAPID contact alias.
PUSH_ALLOW_LOCAL_WEB_PUSH_ENDPOINTSAllows local Web Push endpoints for development and tests.
PUSH_WEBPUSH_ALLOWED_HOSTSComma-separated Web Push endpoint allowlist.
PUSH_WEBPUSH_DENIED_HOSTSComma-separated Web Push endpoint denylist.
PUSH_HMS_ENABLEDEnables HMS dispatch.
HMS_APP_IDHMS app ID for dispatch workers.
PUSH_HMS_APP_IDHMS app ID alias.
HMS_PROVIDER_TOKENHMS provider token.
PUSH_HMS_PROVIDER_TOKENHMS provider token alias.
HMS_ENDPOINTHMS endpoint override.
PUSH_HMS_ENDPOINTHMS endpoint alias.
PUSH_WNS_ENABLEDEnables WNS dispatch.
WNS_PROVIDER_TOKENWNS provider token.
PUSH_WNS_PROVIDER_TOKENWNS provider token alias.

On this page