Skip to main content

Configuration

Regius uses environment variables for configuration. When you create a new application, a .env file is generated with default configurations.

Basic Configuration​

# Application name, without spaces
APP_NAME=testapp
APP_URL="http://localhost:4000"

# False for production, true for development
DEBUG=true

# Port settings
PORT=4000
RPC_PORT=4001

# Server name, e.g, www.example.com
SERVER_NAME=localhost

# Use HTTPS?
SECURE=false

Database Configuration​

# Database type: postgres, mysql, mariadb, sqlite
DATABASE_TYPE=
DATABASE_HOST=
DATABASE_PORT=
DATABASE_USER=
DATABASE_PASS=
DATABASE_NAME=
DATABASE_SSL_MODE=

You can also configure databases via the config/database.yml file:

development:
  dialect:
  database:
  user:
  password:
  host:
  port:
  pool: 5

Storage Configuration​

MinIO Configuration​

MINIO_ENDPOINT=
MINIO_KEY=
MINIO_SECRET=
MINIO_USESSL=
MINIO_REGION=
MINIO_BUCKET=

S3 Configuration​

S3_KEY=
S3_SECRET=
S3_REGION=
S3_BUCKET=
S3_ENDPOINT=

SFTP Configuration​

SFTP_HOST=
SFTP_PORT=
SFTP_USER=
SFTP_PASS=

WebDAV Configuration​

WEBDAV_HOST=
WEBDAV_PORT=
WEBDAV_USER=
WEBDAV_PASS=
WEBDAV_USESSL=

Cache Configuration​

# Cache backend: redis or badger
CACHE=

# Redis settings
REDIS_HOST=
REDIS_PASSWORD=
REDIS_PREFIX=testapp

Session Configuration​

# Session store: cookie, mysql, mariadb, postgres or redis
SESSION_TYPE=cookie

# Cookie settings
COOKIE_NAME=testapp
COOKIE_LIFETIME=1440
COOKIE_PERSISTS=true
COOKIE_SECURE=false
COOKIE_DOMAIN=localhost

Mail Configuration​

SMTP Configuration​

SMTP_HOST=
SMTP_USERNAME=
SMTP_PASSWORD=
SMTP_PORT=
SMTP_ENCRYPTION=
MAIL_DOMAIN=
FROM_NAME=
FROM_ADDRESS=

API Mailer Configuration​

MAILER_API=
MAILER_KEY=
MAILER_URL=

OAuth Configuration​

GitHub OAuth​

GITHUB_KEY=
GITHUB_SECRET=
GITHUB_CALLBACK=

Google OAuth​

GOOGLE_KEY=
GOOGLE_SECRET=
GOOGLE_CALLBACK=

Other Configuration​

# Template engine: jet or go
RENDERER=jet

# Encryption key (32 characters long)
KEY=DPFtfVnxbtnXXRzVnRzrLxDzXXRh+Xft

# File upload settings
ALLOWED_FILETYPES="image/png,image/jpeg,image/gif,application/pdf"
# 5MB in bytes
MAX_FILESIZE=5242880

Docker Compose Configuration​

# PostgreSQL
POSTGRES_DB=
POSTGRES_USER=
POSTGRES_PASSWORD=

# MySQL
MYSQL_DATABASE=
MYSQL_USER=
MYSQL_PASSWORD=
MYSQL_ROOT_PASSWORD=

Make sure to fill in all required values before running your application in production.