Environment Variables

A comprehensive reference of all environment variables supported by DataRamen.

Server configuration

Variable name	Accepted values / description
ALLOWED_ORIGINS	CORS configuration. When self-hosting, set this to your application’s hostname
PORT	Port on which the DataRamen server will listen

Database configuration

Variable name	Accepted values / description
APP_DB_TYPE	mysql or postgres
APP_DB_HOST	URL or hostname of your database
APP_DB_PORT	Database port
APP_DB_DATABASE	Database name
APP_DB_USERNAME	Database username
APP_DB_PASSWORD	Database user password
APP_DB_SCHEMA	Database schema (Postgres only)
APP_DB_LOGGING	Enables logging of internal queries executed by DataRamen for its own operations

Data encryption configuration

Variable name	Accepted values / description
SYMM_ENCRYPTION_KEY	Secret key used to encrypt the database password (instructions)
JWT_SECRET	Secret key used to generate JWT tokens (instructions)
JWT_REFRESH_SECRET	Secret key used to generate JWT refresh tokens (instructions)

Updating environment variables via the DataRamen CLI

After installing DataRamen, you can set an environment variable using:

dataramen env set [variable_name] [variable_value]

For example, to update APP_DB_TYPE:

dataramen env set APP_DB_TYPE mysql

Templates

MySQL

# for selfhosted services, otherwise leave empty
# ALLOWED_ORIGINS=https://yourdomain.com
# PORT=4466

# Data encryption
SYMM_ENCRYPTION_KEY=<encryption_key>
JWT_SECRET=<jwt_secret_key>
JWT_REFRESH_SECRET=<jwt_refresh_key>

# DB configuration
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

# for selfhosted services, otherwise leave empty
# ALLOWED_ORIGINS=https://yourdomain.com
# PORT=4466

# Data encryption
SYMM_ENCRYPTION_KEY=<encryption_key>
JWT_SECRET=<jwt_secret_key>
JWT_REFRESH_SECRET=<jwt_refresh_key>

# DB configuration
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

SQLite

# for selfhosted services, otherwise leave empty
# ALLOWED_ORIGINS=https://yourdomain.com
# PORT=4466

# Data encryption
SYMM_ENCRYPTION_KEY=<encryption_key>
JWT_SECRET=<jwt_secret_key>
JWT_REFRESH_SECRET=<jwt_refresh_key>

# DB configuration
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