Skip to main content

Environment Variables

Control configuration by setting environment variables.

Minimal Set​

Below is the minimal set of environment variables you need to use in order to deploy GoRules BRMS:

DB_HOST=        # Database Host
DB_USER=        # Database User
DB_PASSWORD=    # Database Password
DB_NAME=        # Database Name

LICENSE_KEY=    # License Key obtained from https://portal.gorules.io

Advanced Options​

# General
APP_NAME=GoRules                  # App name (optional)
APP_URL=http://localhost:4200     # App url (optional)
HOME_URI=/                        # Home URI (optional)

# Database
DB_PORT=5432                     # Database port (optional)
DB_LOGGING=false                 # Database logging (optional)
DB_SYNCHRONIZE=false             # Enable automatic model synchronization (optional)
DB_MIGRATE=true                  # Enable database migration (optional)
DB_REJECT_UNAUTHORIZED=true      # Reject unauthorized access for the database. Acts as an SSL bypass. (optional)

# Authentication and security
SESSION_DURATION_MINUTES=1440   # Duration of signin in minutes (optional)
COOKIE_SECRET=cookie-secret     # Cookie secret (optional) - should be changed

# Email configuration (User invites, authentication, etc) - leave empty to use the GoRules emailing service
EMAIL_ENABLED=true               # Enable email authentication (optional)
EMAIL_URL=https://portal.gorules.io   # URL for email (optional)
EMAIL_FROM=[email protected]    # Email from (optional)
EMAIL_HOST=                      # SMTP Email host (optional)
EMAIL_PORT=                      # SMTP Email port (optional)
EMAIL_SECURE=false               # SMTP Email secure flag (optional)
EMAIL_TLS_REJECT_UNAUTHORIZED=   # SMTP Email reject unauthorized (optional)
EMAIL_AUTH_USER=                 # SMTP Auth User (optional)
EMAIL_AUTH_PASS=                 # SMTP Auth Pass (optional)

# GitHub Authentication (not available on FREE plan)
AUTH_GITHUB_ENABLED=false        # GitHub auth enabled (optional)
AUTH_GITHUB_CLIENT_ID=           # GitHub client id (optional)
AUTH_GITHUB_CLIENT_SECRET=       # GitHub client secret (optional)
AUTH_GITHUB_REDIRECT_URI=        # GitHub redirect URI (optional)

# Google authentication (not available on FREE plan)
AUTH_GOOGLE_ENABLED=false        # Google auth enabled (optional)
AUTH_GOOGLE_CLIENT_ID=           # Google client id (required Google SSO is enabled)
AUTH_GOOGLE_CLIENT_SECRET=       # Google client secret (required Google SSO is enabled)
AUTH_GOOGLE_REDIRECT_URI=        # Google redirect URI (required Google SSO is enabled)