Configuration

CastKeeper is configured using a YAML config file (castkeeper.yml), environment variables, or a mixture of both.

Config files

Config files are loaded by the CastKeeper server when it starts - either from a path specified when starting the server, or from the default CastKeeper config path. Only the first config file found is loaded, following this order:

1. The path specified as an argument when running the CastKeeper server, e.g. castkeeper serve --config /path/to/my/castkeeper.yml
2. ./castkeeper.yml - in the current working directory where the CastKeeper server was started.
3. /etc/castkeeper/castkeeper.yml

Example config file

EnvName: prod
LogLevel: warn
BaseURL: https://castkeeper.example.com
DataPath: /app/data

WebServer:
  Port: 8080

ObjectStorage:
  Driver: awss3
  S3Bucket: my-castkeeper-bucket
  S3Prefix: podcasts/

Environment variables

Every CastKeeper config option can alternatively be specified as an environment variable.

The names of environment variables follow a convention:

• the config file option EnvName would become CASTKEEPER_ENVNAME.
• the nested config file option WebServer.Port would become CASTKEEPER_WEBSERVER_PORT

See the reference table below for the full list of environment variables.

Config reference

Config option	Environment variable	Description
LogLevel	CASTKEEPER_LOGLEVEL	Log verbosity. Allowed values: debug,info, warn, error. Default value: info.
EnvName	CASTKEEPER_ENVNAME	The name of the environment, used in logs. Default value: unknown.
BaseURL	CASTKEEPER_BASEURL	The URL that CastKeeper is hosted at, e.g. https://ck.example.com. Required.
DataPath	CASTKEEPER_DATAPATH	The path to the directory that CastKeeper uses to store its data, e.g. /app/data. Required.
WebServer.Port	CASTKEEPER_WEBSERVER_PORT	The port the web server should listen to. Default value: 8080.
ObjectStorage.Driver	CASTKEEPER_OBJECTSTORAGE_DRIVER	The object storage provider to use. Allowed values: local, awss3. Required.
ObjectStorage.S3Bucket	CASTKEEPER_OBJECTSTORAGE_S3BUCKET	The S3 bucket to use for file storage when using the awss3 provider. Required when Driver is awss3.
ObjectStorage.S3Prefix	CASTKEEPER_OBJECTSTORAGE_S3PREFIX	Optional prefix for files when using the awss3 provider.
ObjectStorage.S3ForcePathStyle	CASTKEEPER_OBJECTSTORAGE_S3FORCEPATHSTYLE	Boolean value. Usually false, may need to be set to true for some S3 compatible storage services. Default value: false.