Configure a custom app DB

DataRamen gives you full control over where application data is stored. By default, a local SQLite database is created on the host machine.

Caution

The default SQLite database is suitable for local CLI usage, but you should configure an external database when self-hosting. Self-hosted services typically run in ephemeral environments where local SQLite data will not persist across restarts.

Below are example configurations for each supported database:

SQLite

APP_DB_TYPE=sqlite
APP_DB_DATABASE=        # optional, path to the SQLite file; use <home> as a placeholder for the home directory
APP_DB_LOGGING=FALSE    # optional, set to TRUE to enable internal SQL logging

MySQL

APP_DB_TYPE=mysql
APP_DB_HOST=            # DB host URL
APP_DB_PORT=3306        # DB host port
APP_DB_DATABASE=        # DB name
APP_DB_USERNAME=        # access username
APP_DB_PASSWORD=        # access password
APP_DB_LOGGING=FALSE    # optional, set to TRUE to enable internal SQL logging

Postgres

APP_DB_TYPE=postgres
APP_DB_HOST=            # DB host URL
APP_DB_PORT=5432        # DB host port
APP_DB_DATABASE=        # DB name
APP_DB_USERNAME=        # access username
APP_DB_PASSWORD=        # access password
APP_DB_SCHEMA=          # schema
APP_DB_LOGGING=FALSE    # optional, set to TRUE to enable internal SQL logging

Caution

When connecting to a production database, it is strongly recommended to create a dedicated database user with read-only access.

Refer to the Environment Variables guide for instructions on updating these values.