Skip to content

Config S3

You can use a S3 bucket as a persistent storage backend for the server config.

This is useful in distributed deployments where multiple instances need to share the same config state.

To use S3 bucket as you persistent storage set the ZENITH_CONFIG_DRIVER environment variable to s3 and provide the necessary S3 credentials and bucket information.

Required environment variables:

VariableRequiredDescription
ZENITH_CONFIG_S3_BUCKETS3 bucket name
ZENITH_CONFIG_S3_REGIONAWS region
ZENITH_CONFIG_S3_ACCESS_KEY_IDAccess key ID
ZENITH_CONFIG_S3_SECRET_ACCESS_KEYSecret access key
ZENITH_CONFIG_S3_ENDPOINTCustom endpoint (for S3-compatible services)
ZENITH_CONFIG_S3_PREFIXKey prefix inside the bucket
ZENITH_CONFIG_S3_SESSION_TOKENSession token

Example:

sh
ZENITH_CONFIG_DRIVER=s3
ZENITH_CONFIG_S3_BUCKET=my-config-bucket
ZENITH_CONFIG_S3_REGION=us-east-1
ZENITH_CONFIG_S3_ACCESS_KEY_ID=AKIA...
ZENITH_CONFIG_S3_SECRET_ACCESS_KEY=...
ZENITH_CONFIG_S3_PREFIX=config/