Configuration

Burdy is very flexible, this in terms means that it comes with a lot of options that you can customize to fit your needs. This document will mostly focus on environment variables available in Burdy. All of these settings have a default fallback, so you only need to customize things based on your requirements.

Base Configuration

# Represents Burdy host. This is used to configure asset URLs.
BURDY_HOST=https://cms.burdy.io 
# Used for signing cookies inside of Burdy. Security option
SIGNED_COOKIE=mySecret
# Port for running Burdy CMS
SERVER_PORT=4000
# Port for running Burdy admin. Only needed inside of development environment.
ADMIN_PORT=4001
# Cache control e.g. max-age=2592000 or no-cache
ASSETS_CACHE_CONTROL="max-age=2592000"

Database

The database is configurable 100% based on TypeORM environment variables. To see the complete list, please refer to TypeORM documentation.

# Database type, possible values: sqlite (default)|postgres|mysql|mariadb
TYPEORM_CONNECTION=postgres
# Database host
TYPEORM_HOST=localhost
# Database username
TYPEORM_USERNAME=postgres
# Database password
TYPEORM_PASSWORD=postgres
# Database name
TYPEORM_DATABASE=burdy
# Database port
TYPEORM_PORT=5432
# Synchronization - should always be off in production.
# Allows for fast updates to database models in development environment
TYPEORM_SYNCHRONIZE=true
# Database logging - very useful during debugging of queries
TYPEORM_LOGGING=false

Object Storage

Object storage is used to store the assets and backups inside of Burdy at the moment. In the future, it may have other uses, and also you are able to use FileStorage for your custom needs as well.

# File Driver, possible values: fs (default) and aws_s3
# Note that aws_s3 is used for any S3 (such as DigitalOcean Object Storage)
FILE_DRIVER=aws_s3
# S3 Access Key
AWS_ACCESS_KEY_ID=
# S3 Secret Key
AWS_SECRET_ACCESS_KEY=
# S3 Region
AWS_S3_REGION=us-west-1
# S3 Bucket
AWS_S3_BUCKET=burdy-bucket
# S3 Endpoint - when using DigitalOcean this can be: nyc3.digitaloceanspaces.com
# Otherwise this can be kept empty
AWS_S3_ENDPOINT=nyc3.digitaloceanspaces.com

Preview Editor

Preview editor allows you to preview the changes inside of Burdy before making the content updates. This allows for a more consistent delivery of content.

# Flag to enable preview editor
PUBLIC_ENABLE_PREVIEW_EDITOR=true
# Base URL for the preview editor
PREVIEW_BASE_URL=http://localhost:3000

Copyright © Burdy Technologies. All rights reserved.