Skip to main content

Configure your database

This guide will help you configure your database. Parameters here should not be changed after installation unless you know what you are doing, as it may result in data losses.

PostgreSQL#

You can use the provided database, or bring your own. Both can be used with any installation method (embedded cluster or existing cluster).

Embedded versus external#

The embedded PostgreSQL requires no additional configuration. It is great for testing and small-size instances. It does not provide high availability. For backups, refer to the backup page.

The external PostgreSQL requires having an external database set up (e.g. with RDS on AWS). This is the recommended setup for large-scale deployments. Scaling, high availability, and backups should be managed with the provider's tools.

Embedded configuration#

The embedded PostgreSQL is a PostgreSQL 12 running on a single pod.
The only configurable option is the size of the disk. The default value should be enough for most cases.

You may increase it after installation, but not decrease it.
See here for detailed procedure and prerequisites.

External configuration#

For an external PostgreSQL, you have the following configuration options:

  • Host: the IP or hostname for your PostgreSQL. Defaults to "postgres".
  • Port: the port on which PostgreSQL listens. Defaults to "5432".
  • Username: the user used to connect to the database. Required.
  • Password: the password used to connect to the database. Required.
  • Database: the name of the database to connect to. Defaults to "prm". The database must exist.

For scaling recommendations, refer to the hardware requirements for embedded clusters or existing clusters.

Redis#

You can use the provided cache, or bring your own. Both can be used with any installation method (embedded cluster or existing cluster).

Type: embedded/external#

The embedded Redis requires no additional configuration. It is great for testing and small-size instances.
It does not provide high availability.
For backups, refer to the backup page.

The external Redis requires having an external cache set up (e.g. with Elasticache on AWS). This is the recommended setup for large-scale deployments.
Scaling, high availability, and backups should be managed with the provider's tools.

External configuration#

For an external Redis, you have the following configuration options:

  • Host: the IP or hostname for your Redis. Defaults to "redis".
  • Port: the port on which Redis listens. Defaults to "6379".
  • Username: the user used to connect to the cache. Can be left empty.
  • Password: the password used to connect to the cache. Required.
  • Use TLS: checkbox to specify how to communicate with Redis.