Skip to main content

Configurations

Datalus is configured with the datalus.conf file in the project root. This configuration file is automatically generated through the Datalus CLI. When this file is changed, the server must be restarted for changes to take effect. This is simply an env file, so variables may also be defined directly in the environment. Below are the available configuration options.

general

ADMIN_PASSWORDstring
Required

Default password to the `admin` account. The `admin` account password resets to this value on server start

Example: hunter2


PORTnumber

Port that the API server listens to

Default value: 8080


STORAGE_MODEaws | db
Required

Whether Datalus saves generated data in an AWS S3 bucket or directly in the PostgreSQL database as a blob

Example: aws


VM_MODEaws | local
Required

Whether Datalus generates data on an AWS ECS Fargate container or on Docker locally

Example: aws


LOCAL_GENERATOR_IMAGE_NAMEstring
Required for Local Docker Generation Mode

Docker name of generator image

Example: wisnicki/datalus-generator:latest


ENABLE_SIGNUPSboolean
Required

Allow new sign ups on Datalus instance

Example: true


db

DB_HOSTstring
Required

URL of Datalus Database

Example: mydb.datalus.com


DB_PORTnumber
Required

Port of Datalus Database

Example: 5432


DB_USERNAMEstring
Required

Datalus Database Username

Example: postgres


DB_PASSWORDstring
Required

Datalus Database Password Credentials

Example: hunter2


DB_NAMEstring
Required

Database name in Postgres server that will be used

Example: datalus


DB_SCHEMAstring
Required

Schema to store all Datalus tables in

Example: public


DB_REJECT_UNAUTHORIZEDboolean
Required

Reject connection to Datalus DB if cannot match against CAs

Example: true


DB_CA_PATHboolean
Required if DB_REJECT_UNAUTHORIZED = true

Path to file with Database CAs relative to the root folder of Datalus

Example: ./global-bundle.pem


aws

AWS_ACCESS_KEYstring
Required for AWS Generation ModeRequired for AWS Storage Mode

AWS AIM Access Key

Example: 97AVMMF8C9E*******


AWS_SECRET_ACCESS_KEYstring
Required for AWS Generation ModeRequired for AWS Storage Mode

AWS AIM Secret Access Key

Example: 7A105WhbfrBpQTxw*******


AWS_REGIONstring
Required for AWS Generation ModeRequired for AWS Storage Mode

AWS Region for Resources

Example: us-east-1


AWS_BUCKETstring
Required for AWS Storage Mode

AWS Bucket Name

Example: us-east-1


AWS_ECS_SUBNETSstring
Required for AWS Generation Mode

Comma separated list of subnets used for ECS containers

Example: subnet-123,subnet-345,subnet-abc,subnet-def


AWS_ECS_SECURITY_GROUPSstring
Required for AWS Generation Mode

Comma separated list of security groups used for ECS containers

Example: sg-123,sg-345,sg-abc


AWS_ECS_CLUSTERstring
Required for AWS Generation Mode

TODO

Example: datalus-generator-cluster


AWS_ECS_TASK_DEFINITIONstring
Required for AWS Generation Mode

TODO

Example: datalus-generator-task


ai

LLM_BATCH_ROW_LIMITnumber
Required

Max rows to generate per LLM call

Example: 100


OPENAI_API_KEYstring
Required

OpenAI API Key

Example: sk-proj-AdPFWsas0*******


advanced

NODE_ENVproduction | development
Required

Environment mode for Node.js. Recommended to keep as production

Example: production


SHARD_OUTPUT_PREVIEW_LIMITnumber
Required

Max rows to preview per generated shard

Example: 50


AUTH_ACCESS_TOKEN_PRIVATE_KEYstring
Required

Base64-encoded private key for auth access tokens

Example: A very long string that looks like this: LS0tWRV****ktLS0tLQ==


AUTH_ACCESS_TOKEN_PUBLIC_KEYstring
Required

Base64-encoded public key for auth access tokens

Example: A very long string that looks like this: LS0tWRV****ktLS0tLQ==


AUTH_REFRESH_TOKEN_PRIVATE_KEYstring
Required

Base64-encoded private key for auth refresh tokens

Example: A very long string that looks like this: LS0tWRV****ktLS0tLQ==


AUTH_REFRESH_TOKEN_PUBLIC_KEYstring
Required

Base64-encoded public key for auth refresh tokens

Example: A very long string that looks like this: LS0tWRV****ktLS0tLQ==


AUTH_ACCESS_TOKEN_TTLnumber
Required

Time in ms until an issued access token expires

Example: 60000


AUTH_REFRESH_TOKEN_TTLnumber
Required

Time in ms until an issued refresh token expires

Example: 120000


CORS_ORIGINstring
Required

CORS Origin Domain

Example: mydomain.com


VITE_API_URLstring
Required

API URL that web client fetches

Example: mydomain.com


Domain that cookies are attached to

Example: mydomain.com


TZstring
Required

Server Timezone

Example: UTC