Skip to content
DataRamen

Self-hosting DataRamen

The easiest way to self-host DataRamen is by cloning the GitHub repo and running it wherever you prefer (Docker container, managed service, or directly on a server).

Here’s an example workflow to clone, build, and start the service:

Terminal window
git clone https://github.com/OleksandrDemian/dataramen.git
cd dataramen
npm install       # install dependencies
npm package:app   # package app for self hosting
npm start         # start dataramen service, please create env file before running start

Env configuration

Section titled “Env configuration”

You can configure the service with a .env file in the project root (alongside package.json).

The following environment variables are required:

  • SYMM_ENCRYPTION_KEY: key used to encrypt database passwords
  • JWT_SECRET: key used to generate JWT tokens
  • JWT_REFRESH_SECRET: key used to generate JWT refresh tokens
  • ALLOWED_ORIGINS: comma-separated list of origins allowed to access the service

See here on how to generate secret keys.

Here is an example of minimal .env file:

ALLOWED_ORIGINS=https://yourdomain.com
SYMM_ENCRYPTION_KEY=encryption_key
JWT_SECRET=jwt_secret_key
JWT_REFRESH_SECRET=jwt_refresh_key

Default app database

Section titled “Default app database”

By default, the DataRamen CLI uses a local SQLite database to store app data (e.g., users, permissions, saved queries).

First login

Section titled “First login”