Configurations
Datalus is configured with the datalus.conf
file in the project root. 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.
Name | Description | Type | Required | Example |
---|---|---|---|---|
DB_HOST | URL of Datalus Database | string | Required | mydb.datalus.com |
DB_PORT | Port of Datalus Database | number | Required | 5432 |
DB_USERNAME | Datalus Database Username | string | Required | postgres |
DB_PASSWORD | Datalus Database Password Credentials | string | Required | hunter2 |
DB_NAME | Database name in Postgres server that will be used | string | Required | datalus |
DB_SCHEMA | Schema to store all Datalus tables in | string | Required | public |
DB_REJECT_UNAUTHORIZED | Reject connection to Datalus DB if cannot match against CAs | boolean | Required | true |
DB_CA_PATH | Path to file with Database CAs | boolean | Required if DB_REJECT_UNAUTHORIZED is true | ./global-bundle.pem |
STORAGE_MODE | Path to file with Database CAs | aws | db | Required | aws |
VM_MODE | Path to file with Database CAs | aws | local | Required | aws |
LLM_BATCH_ROW_LIMIT | Max rows to generate per LLM call | number | Required | 100 |
OPENAI_API_KEY | OpenAI API Key | string | Required | sk-proj-AdPFWsas0******* |
AWS_ACCESS_KEY | AWS AIM Access Key | string | Required for AWS Storage Mode or VM Mode | 97AVMMF8C9E******* |
AWS_SECRET_ACCESS_KEY | AWS AIM Secret Access Key | string | Required for AWS Storage Mode or VM Mode | 7A105WhbfrBpQTxw******* |
AWS_REGION | AWS Region for Resources | string | Required for AWS Storage Mode or VM Mode | us-east-1 |
AWS_BUCKET | AWS Bucket Name | string | Required for AWS Storage Mode | us-east-1 |
AWS_ECS_SUBNETS | Comma separated list of subnets used for ECS containers | string | Required for AWS VM Mode | subnet-123,subnet-345,subnet-abc,subnet-def |
AWS_ECS_SECURITY_GROUPS | Comma separated list of security groups used for ECS containers | string | Required for AWS VM Mode | sg-123,sg-345,sg-abc |
NODE_ENV | Environment mode for Node.js. Recommended to keep as production | production | development | Required | production |
LOCAL_GENERATOR_IMAGE_NAME | Docker name of generator image | string | Required for Local VM Mode | generators:latest |
SHARD_OUTPUT_PREVIEW_LIMIT | Max rows to preview per generated shard | number | Required | 50 |
AUTH_ACCESS_TOKEN_PRIVATE_KEY | Base64-encoded private key for auth access tokens | string | Required | A very long string that looks like this: LS0tWRV****ktLS0tLQ== |
AUTH_ACCESS_TOKEN_PUBLIC_KEY | Base64-encoded public key for auth access tokens | string | Required | A very long string that looks like this: LS0tWRV****ktLS0tLQ== |
AUTH_REFRESH_TOKEN_PRIVATE_KEY | Base64-encoded private key for auth refresh tokens | string | Required | A very long string that looks like this: LS0tWRV****ktLS0tLQ== |
AUTH_REFRESH_TOKEN_PUBLIC_KEY | Base64-encoded public key for auth refresh tokens | string | Required | A very long string that looks like this: LS0tWRV****ktLS0tLQ== |
AUTH_ACCESS_TOKEN_TTL | Time in ms until an issued access token expires | number | Required | 60000 |
AUTH_REFRESH_TOKEN_TTL | Time in ms until an issued refresh token expires | number | Required | 120000 |
CORS_ORIGIN | CORS Origin Domain | string | Required | mydomain.com |
VITE_API_URL | API URL that web client fetches | string | Required | mydomain.com |
COOKIE_DOMAIN | Domain that cookies are attached to | string | Required | mydomain.com |
TZ | Server Timezone | string | Required | UTC |
ENABLE_SIGNUPS | Allow new sign ups on Datalus instance | boolean | Required | false |