Skip to main content
Version: v3

OnPrem Environment Variables

This guide expands on environment variables when hosting Flatfile in your own cloud.


API-WEB / API-WORKER

Access key configuration

ACCESS_KEY_BCRYPT_HASH_ROUNDS: "12"
ACCESS_KEY_EXCHANGE_TIMEBOX: "500"

Monitoring configuration

See the official DataDog Helm chart for additional configuration detail

DD_ENV: ca0-production
DD_LOGS_INJECTION: "true"
DD_PROFILING_ENABLED: "true"
ENABLE_BULL_BOARD=true
BULL_BOARD_USERNAME=flatfile
BULL_BOARD_PASSWORD=flatfile
METRICS_USERNAME=flatfile
METRICS_PASSWORD=flatfile
SENTRY_ENVIRONMENT: ca0-production
SENTRY_TRACES_SAMPLE_RATE: "0.1"

General Configuration

AWS_REGION: ca-central-1
BASE_URL: https://api.ca0.flatfile.com
FLATFILE_DASHBOARD_URL: https://app.ca0.flatfile.com/
FLATFILE_ENV: onprem
FLATFILE_REFINERY_WS_URL: wss://api.ca0.flatfile.com
GITHUB_CB_URL: https://api.ca0.flatfile.com/auth/github/callback
GRAPHQL_SCHEMA_IN_MEMORY: "true"
JWT_EXPIRES_HOURS: "12"
PROJECT_PATH: core/api
REDIRECT_URL: https://app.ca0.flatfile.com

Data Hooks®

LAMBDA_FACTORY_ARN: arn:aws:lambda:ca-central-1:xxxxxxxxxxx:function:lambdaFactory

Email sending

MAIL_SEND_AS: Flatfile Inc. <hello@ca0.flatfile.com>
MAIL_TRANSPORT: ses

Object storage

OBJECT_STORAGE_BUCKET: flatfile-prod-ca0-uploads
OBJECT_STORAGE_PROVIDER: s3
OBJECT_STORAGE_USE_ACCELERATION: "true"

Postgres configuration

PG_AUTH_STYLE: rds_iam
PGHOST: refinery.cluster-abcdefghikj.ca-central-1.rds.amazonaws.com
PGNAME: flatfile
PGPORT: "5432"
POSTGRES_CONNECTION_TIMEOUT: "5000"

SFTP configuration

SFTP_AUTH_TOKEN: ""
SFTP_BUCKET: flatfile-prod-ca0-transfer
SFTP_ROLE: arn:aws:iam::xxxxxxxxxxx:role/transfer-server-iam-role
SFTP_ROOT: sftp

TypeORM configuration

TYPEORM_LOGGER: simple-console
TYPEORM_LOGGING: error,schema,warn
TYPEORM_MAX_QUERY_EXECUTION_TIME: "2000"