Fyren Docs

Configuration

All configuration options for your Fyren instance.

Fyren is configured through environment variables. All variables can be set in a .env file or passed directly to the Docker container.

Required Variables

VariableDescriptionExample
DATABASE_URLPostgreSQL connection stringpostgres://user:pass@localhost:5432/fyren
REDIS_URLRedis connection stringredis://localhost:6379
BASE_URLPublic URL of your Fyren instancehttps://status.example.com

Authentication

VariableDescriptionDefault
AUTH_SECRETSecret key for session signing(auto-generated)
AUTH_TRUST_HOSTTrust the X-Forwarded-Host headerfalse

Email

VariableDescriptionDefault
EMAIL_PROVIDEREmail provider: ses, sendgrid, or smtpsmtp
SMTP_HOSTSMTP server host
SMTP_PORTSMTP server port587
SMTP_USERSMTP username
SMTP_PASSSMTP password
SMTP_FROMDefault "from" address[email protected]
SENDGRID_API_KEYSendGrid API key (when using SendGrid)
AWS_REGIONAWS region for SESus-east-1

Monitoring

VariableDescriptionDefault
DEFAULT_CHECK_INTERVALDefault monitor check interval in seconds60
DEFAULT_TIMEOUTDefault request timeout in milliseconds10000
DEFAULT_FAILURE_THRESHOLDFailures before marking as down3

Branding

VariableDescriptionDefault
ORG_NAMEOrganization name displayed on status pageMy Organization
ORG_LOGO_URLURL to organization logo
BRAND_COLORPrimary brand color (hex)#d4c9b8

Advanced

VariableDescriptionDefault
PORTPort to listen on3000
LOG_LEVELLogging level: debug, info, warn, errorinfo
CORS_ORIGINSAllowed CORS origins (comma-separated)*
RATE_LIMIT_MAXMax requests per window for rate limiting100
RATE_LIMIT_WINDOWRate limit window in seconds60

On this page