2026/10/17reading time+ 3 min

Redis Configuration

Warning

monetr is migrating away from using this configuration to a new config layout, this configuration will continue to work for the next few releases but will eventually break and default to an in memory cache setup. If you're setup requires a shared cache server then please add the new cache block to your configuration file. If your setup does not require a shared cache server then no action is required from you, and monetr will simply default to the in memory cache in an upcoming release.

monetr can use any cache that is compatible with Redis's wire protocol. In the provided Docker compose file, local development environment as well as in production valkey is used.

monetr only caches a few things, and for self-hosting it may not even be necessary to run a dedicated cache at this time as monetr also leverages miniredis when a cache server has not been configured. For a single monetr server this embedded "Redis" is sufficient.

To configure a dedicated cache server though:

config.yaml

redis:
  enabled: <true|false> # If this is set to false then miniredis is used.
  address: "localhost"
  port: 6379
  database: 0
  username: ""
  password: ""
  tls: false
  insecureSkipVerify: false
  caCertificatePath: "</tls/ca.cert>"
  keyPath: "</tls/tls.key>"
  certificatePath: "</tls/tls.cert>"

Name	Type	Default	Description
`enabled`	Boolean	`false`	Enable a dedicated cache server, if this is set to `false` then an embedded miniredis instance is used instead.
`address`	String		The IP, or DNS resolvable address of your Redis-compatible cache server.
`port`	Number	`6379`	Port that the Redis-compatible cache server can be reached at.
`database`	Number	`0`	Database number that you want monetr to use for caching. Defaults to `0`.
`username`	String		Username used to authenticate to the Redis-compatible server, defaults to an empty string.
`password`	String		Password used to authenticate to the Redis-compatible server, defaults to an empty string.
`tls`	Boolean	`false`	If true then monetr will connect to the cache server using TLS. TLS is also used if any of the certificate paths below are provided.
`insecureSkipVerify`	Boolean	`false`	If you are using TLS with the cache server but are not distributing a certificate authority file, then you may need to skip TLS verification.
`caCertificatePath`	String		Path to the certificate authority certificate file. If you are verifying your TLS connection then this is required or the server certificate must be among the hosts certificate authorities already.
`keyPath`	String		Path to the client TLS key that monetr should use to connect to the cache server.
`certificatePath`	String		Path to the client TLS certificate that monetr should use to connect to the cache server.

Info

monetr watches the certificate files for changes, so certificates can be rotated without restarting the server. New connections to the cache server will use the new certificates right away. The TLS settings are ignored when enabled is false.

The following environment variables map to the following configuration file fields. Each field is documented below.

Variable	Config File Field
`MONETR_REDIS_ENABLED`	`redis.enabled`
`MONETR_REDIS_ADDRESS`	`redis.address`
`MONETR_REDIS_PORT`	`redis.port`
`MONETR_REDIS_DATABASE`	`redis.database`
`MONETR_REDIS_USERNAME`	`redis.username`
`MONETR_REDIS_PASSWORD`	`redis.password`
`MONETR_REDIS_TLS`	`redis.tls`
`MONETR_REDIS_INSECURE_SKIP_VERIFY`	`redis.insecureSkipVerify`
`MONETR_REDIS_CA_PATH`	`redis.caCertificatePath`
`MONETR_REDIS_KEY_PATH`	`redis.keyPath`
`MONETR_REDIS_CERT_PATH`	`redis.certificatePath`

#Redis Configuration

Redis Configuration