.env.example

###############################################################################
###############################################################################
#
# This file is auto-generated.
#
# Copy it to .env and uncomment set or adjust any options you need.
#
# There are three ways how this options are loaded when Corteza starts:
#  1. Environmental variables are always loaded and can not be overrided
#     by alternative sources (below) (*)
#  2. If one or more --env-file flag is provided corteza looks in the provided
#     locations (either file or directory containing .env)
#  3. Directory where the corteza binary is located is scanned for .env file)
#
# (*) You can use mechanisms from docker or docker-compose to set or load
#     environmental variables as well

###############################################################################
###############################################################################
# Connection to data store backend
#

###############################################################################
# Database connection string.
# Type:    string
# Default: sqlite3://file::memory:?cache=shared&mode=memory
# DB_DSN=sqlite3://file::memory:?cache=shared&mode=memory

###############################################################################
###############################################################################
# HTTP Client
#

###############################################################################
# Allow insecure (invalid, expired TLS/SSL certificates) connections.
# 
# [IMPORTANT]
# ====
# We strongly recommend keeping this value set to false except for local development or demos.
# ====
# Type:    bool
# Default: <no value>
# HTTP_CLIENT_TLS_INSECURE=<no value>

###############################################################################
# Default timeout for clients.
# Type:    time.Duration
# Default: 30s
# HTTP_CLIENT_TIMEOUT=30s

###############################################################################
###############################################################################
# HTTP Server
#

###############################################################################
# IP and port for the HTTP server.
# Type:    string
# Default: :80
# HTTP_ADDR=:80

###############################################################################
# Log HTTP requests.
# Type:    bool
# Default: <no value>
# HTTP_LOG_REQUEST=<no value>

###############################################################################
# Log HTTP responses.
# Type:    bool
# Default: <no value>
# HTTP_LOG_RESPONSE=<no value>

###############################################################################
# Type:    bool
# Default: <no value>
# HTTP_ERROR_TRACING=<no value>

###############################################################################
# Type:    bool
# Default: <no value>
# HTTP_ENABLE_HEALTHCHECK_ROUTE=<no value>

###############################################################################
# Enable `/version` route.
# Type:    bool
# Default: <no value>
# HTTP_ENABLE_VERSION_ROUTE=<no value>

###############################################################################
# Enable `/debug` route.
# Type:    bool
# Default: <no value>
# HTTP_ENABLE_DEBUG_ROUTE=<no value>

###############################################################################
# Enable (prometheus) metrics.
# Type:    bool
# Default: <no value>
# HTTP_METRICS=<no value>

###############################################################################
# Name for metrics endpoint.
# Type:    string
# Default: corteza
# HTTP_METRICS_NAME=corteza

###############################################################################
# Username for the metrics endpoint.
# Type:    string
# Default: metrics
# HTTP_METRICS_USERNAME=metrics

###############################################################################
# Password for the metrics endpoint.
# Type:    string
# Default: <no value>
# HTTP_METRICS_PASSWORD=<no value>

###############################################################################
# Report HTTP panic to Sentry.
# Type:    bool
# Default: <no value>
# HTTP_REPORT_PANIC=<no value>

###############################################################################
# Base URL (prefix) for all routes (<baseUrl>/auth, <baseUrl>/api, ...)
# Type:    string
# Default: /
# HTTP_BASE_URL=/

###############################################################################
# Type:    bool
# Default: <no value>
# HTTP_API_ENABLED=<no value>

###############################################################################
# When webapps are enabled (HTTP_WEBAPP_ENABLED) this is moved to '/api' if not explicitly set otherwise.
# API base URL is internaly prefixed with baseUrl
# Type:    string
# Default: /
# HTTP_API_BASE_URL=/

###############################################################################
# Type:    bool
# Default: <no value>
# HTTP_WEBAPP_ENABLED=<no value>

###############################################################################
# Webapp base URL is internaly prefixed with baseUrl
# Type:    string
# Default: /
# HTTP_WEBAPP_BASE_URL=/

###############################################################################
# Type:    string
# Default: ./webapp/public
# HTTP_WEBAPP_BASE_DIR=./webapp/public

###############################################################################
# Type:    string
# Default: admin,compose,workflow,reporter
# HTTP_WEBAPP_LIST=admin,compose,workflow,reporter

###############################################################################
# Is SSL termination enabled in ingres, proxy or load balancer that is in front of Corteza?
# By default, Corteza checks for presence of LETSENCRYPT_HOST environmental variable.
# This DOES NOT enable SSL termination in Cortreza!
# Type:    bool
# Default: <no value>
# HTTP_SSL_TERMINATED=<no value>

###############################################################################
# Corteza will directly serve these assets (static files).
# When empty path is set (default value), embedded files are used.
# Type:    string
# Default: <no value>
# HTTP_SERVER_ASSETS_PATH=<no value>

###############################################################################
# Enable web console. When running in dev environment, web console is enabled by default.
# Type:    bool
# Default: <no value>
# HTTP_SERVER_WEB_CONSOLE_ENABLED=<no value>

###############################################################################
# Username for the web console endpoint.
# Type:    string
# Default: admin
# HTTP_SERVER_WEB_CONSOLE_USERNAME=admin

###############################################################################
# Password for the web console endpoint. When running in dev environment, password is not required.
# 
# Corteza intentionally sets default password to random chars to prevent security incidents.
# Type:    string
# Default: <no value>
# HTTP_SERVER_WEB_CONSOLE_PASSWORD=<no value>

###############################################################################
###############################################################################
# RBAC options
#

###############################################################################
# Log RBAC related events and actions
# Type:    bool
# Default: <no value>
# RBAC_LOG=<no value>

###############################################################################
# Type:    string
# Default: <no value>
# RBAC_SERVICE_USER=<no value>

###############################################################################
# Space delimited list of role handles.
# These roles causes short-circuiting access control check and allowing all operations.
# System will refuse to start if check-bypassing roles are also listed as authenticated or anonymous auto-assigned roles.
# Type:    string
# Default: super-admin
# RBAC_BYPASS_ROLES=super-admin

###############################################################################
# Space delimited list of role handles.
# These roles are automatically assigned to authenticated user.
# Memberships can not be managed for these roles.
# System will refuse to start if roles listed here are also listed under anonymous roles
# Type:    string
# Default: authenticated
# RBAC_AUTHENTICATED_ROLES=authenticated

###############################################################################
# Space delimited list of role handles.
# These roles are automatically assigned to anonymous user.
# Memberships can not be managed for these roles.
# Type:    string
# Default: anonymous
# RBAC_ANONYMOUS_ROLES=anonymous

###############################################################################
###############################################################################
# SCIM Server
#

###############################################################################
# Enable SCIM subsystem
# Type:    bool
# Default: <no value>
# SCIM_ENABLED=<no value>

###############################################################################
# Prefix for SCIM API endpoints
# Type:    string
# Default: /scim
# SCIM_BASE_URL=/scim

###############################################################################
# Secret to use to validate requests on SCIM API endpoints
# Type:    string
# Default: <no value>
# SCIM_SECRET=<no value>

###############################################################################
# Use external IDs in SCIM API endpoints
# Type:    bool
# Default: <no value>
# SCIM_EXTERNAL_ID_AS_PRIMARY=<no value>

###############################################################################
# Validates format of external IDs. Defaults to UUID
# Type:    string
# Default: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
# SCIM_EXTERNAL_ID_VALIDATION=^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

###############################################################################
###############################################################################
# Email sending
#
# Configure your local SMTP server or use one of the available providers.
# 
# These values are copied to settings when the server starts and can be managed from the administration console.
# We recommend you remove these values after they are copied to settings.
# If server detects difference between these options and settings, it shows a warning in the log on server start.
#


###############################################################################
# The SMTP server hostname.
# Type:    string
# Default: localhost
# SMPT_HOST=localhost

###############################################################################
# The SMTP post.
# Type:    int
# Default: <no value>
# SMPT_PORT=<no value>

###############################################################################
# The SMTP username.
# Type:    string
# Default: <no value>
# SMPT_USER=<no value>

###############################################################################
# The SMTP password.
# Type:    string
# Default: <no value>
# SMPT_PASS=<no value>

###############################################################################
# The SMTP `from` email parameter
# Type:    string
# Default: <no value>
# SMPT_FROM=<no value>

###############################################################################
# Allow insecure (invalid, expired TLS certificates) connections.
# Type:    bool
# Default: <no value>
# SMPT_TLS_INSECURE=<no value>

###############################################################################
# Type:    string
# Default: <no value>
# SMPT_TLS_SERVER_NAME=<no value>

###############################################################################
###############################################################################
# Actionlog
#

###############################################################################
# Type:    bool
# Default: <no value>
# ACTIONLOG_ENABLED=<no value>

###############################################################################
# Type:    bool
# Default: <no value>
# ACTIONLOG_DEBUG=<no value>

###############################################################################
# Type:    bool
# Default: <no value>
# ACTIONLOG_WORKFLOW_FUNCTIONS_ENABLED=<no value>

###############################################################################
###############################################################################
# API Gateway
#

###############################################################################
# Enable API Gateway
# Type:    bool
# Default: <no value>
# APIGW_ENABLED=<no value>

###############################################################################
# Enable API Gateway debugging info
# Type:    bool
# Default: <no value>
# APIGW_DEBUG=<no value>

###############################################################################
# Enable extra logging
# Type:    bool
# Default: <no value>
# APIGW_LOG_ENABLED=<no value>

###############################################################################
# Enable incoming request body output in logs
# Type:    bool
# Default: <no value>
# APIGW_LOG_REQUEST_BODY=<no value>

###############################################################################
# Enable full debug log on requests / responses - warning, includes sensitive data
# Type:    bool
# Default: <no value>
# APIGW_PROXY_ENABLE_DEBUG_LOG=<no value>

###############################################################################
# Follow redirects on proxy requests
# Type:    bool
# Default: <no value>
# APIGW_PROXY_FOLLOW_REDIRECTS=<no value>

###############################################################################
# Outbound request timeout
# Type:    time.Duration
# Default: 30s
# APIGW_PROXY_OUTBOUND_TIMEOUT=30s

###############################################################################
###############################################################################
# Authentication
#

###############################################################################
# Enable extra logging for authentication flows
# Type:    bool
# Default: <no value>
# AUTH_LOG_ENABLED=<no value>

###############################################################################
# Password security allows you to disable constraints to which passwords must conform to.
# 
# [CAUTION]
# ====
# Disabling password security can be useful for development environments as it removes the need for complex passwords.
# Password security *should be enabled* on production environments to avoid security incidents
# ====
# Type:    bool
# Default: <no value>
# AUTH_PASSWORD_SECURITY=<no value>

###############################################################################
# Secret used for signing JWT tokens.
# 
# [IMPORTANT]
# ====
# If secret is not set, system auto-generates one from DB_DSN and HOSTNAME environment variables.
# Generated secret will change if you change any of these variables.
# ====
# Type:    string
# Default: <no value>
# AUTH_JWT_SECRET=<no value>

###############################################################################
# Access token lifetime
# Type:    time.Duration
# Default: 2h
# AUTH_OAUTH2_ACCESS_TOKEN_LIFETIME=2h

###############################################################################
# Refresh token lifetime
# Type:    time.Duration
# Default: 72h
# AUTH_OAUTH2_REFRESH_TOKEN_LIFETIME=72h

###############################################################################
# Expiration time for the auth JWT tokens.
# Type:    time.Duration
# Default: 720h
# AUTH_JWT_EXPIRY=720h

###############################################################################
# Redirect URL to be sent with OAuth2 authentication request to provider
# 
# `provider` placeholder is replaced with the actual value when used.
# Type:    string
# Default: <no value>
# AUTH_EXTERNAL_REDIRECT_URL=<no value>

###############################################################################
# Secret used for securing cookies
# 
# [IMPORTANT]
# ====
# If secret is not set, system auto-generates one from DB_DSN and HOSTNAME environment variables.
# Generated secret will change if you change any of these variables.
# ====
# Type:    string
# Default: <no value>
# AUTH_EXTERNAL_COOKIE_SECRET=<no value>

###############################################################################
# Frontend base URL. Must be an absolute URL, with the domain.
# This is used for some redirects and links in auth emails.
# Type:    string
# Default: <no value>
# AUTH_BASE_URL=<no value>

###############################################################################
# Session cookie name
# Type:    string
# Default: session
# AUTH_SESSION_COOKIE_NAME=session

###############################################################################
# Session cookie path
# Type:    string
# Default: <no value>
# AUTH_SESSION_COOKIE_PATH=<no value>

###############################################################################
# Session cookie domain
# Type:    string
# Default: <no value>
# AUTH_SESSION_COOKIE_DOMAIN=<no value>

###############################################################################
# Defaults to true when HTTPS is used. Corteza will try to guess the this setting by
# Type:    bool
# Default: <no value>
# AUTH_SESSION_COOKIE_SECURE=<no value>

###############################################################################
# How long do we keep the temporary session
# Type:    time.Duration
# Default: 24h
# AUTH_SESSION_LIFETIME=24h

###############################################################################
# How long do we keep the permanent session
# Type:    time.Duration
# Default: 8640h
# AUTH_SESSION_PERM_LIFETIME=8640h

###############################################################################
# How often are expired sessions and tokens purged from the database
# Type:    time.Duration
# Default: 15min
# AUTH_GARBAGE_COLLECTOR_INTERVAL=15min

###############################################################################
# How many requests from a cerain IP address are allowed in a time window.
# Set to zero to disable
# Type:    int
# Default: 60
# AUTH_REQUEST_RATE_LIMIT=60

###############################################################################
# How many requests from a cerain IP address are allowed in a time window
# Type:    time.Duration
# Default: 1m
# AUTH_REQUEST_RATE_WINDOW_LENGTH=1m

###############################################################################
# Secret used for securing CSRF protection
# 
# [IMPORTANT]
# ====
# If secret is not set, system auto-generates one from DB_DSN and HOSTNAME environment variables.
# Generated secret will change if you change any of these variables.
# ====
# Type:    string
# Default: <no value>
# AUTH_CSRF_SECRET=<no value>

###############################################################################
# Enable CSRF protection
# Type:    bool
# Default: <no value>
# AUTH_CSRF_ENABLED=<no value>

###############################################################################
# Form field name used for CSRF protection
# Type:    string
# Default: same-site-authenticity-token
# AUTH_CSRF_FIELD_NAME=same-site-authenticity-token

###############################################################################
# Cookie name used for CSRF protection
# Type:    string
# Default: same-site-authenticity-token
# AUTH_CSRF_COOKIE_NAME=same-site-authenticity-token

###############################################################################
# Handle for OAuth2 client used for automatic redirect from /auth/oauth2/go endpoint.
# 
# This simplifies configuration for OAuth2 flow for Corteza Web applications as it removes
# the need to suply redirection URL and client ID (oauth2/go endpoint does that internally)
# 
# Type:    string
# Default: corteza-webapp
# AUTH_DEFAULT_CLIENT=corteza-webapp

###############################################################################
# Path to js, css, images and template source files
# 
# When corteza starts, if path exists it tries to load template files from it.
# 
# When empty path is set (default value), embedded files are used.
# Type:    string
# Default: <no value>
# AUTH_ASSETS_PATH=<no value>

###############################################################################
# When enabled, corteza reloads template before every execution.
# Enable this for debugging or when developing auth templates.
# 
# Should be disabled in production where templates do not change between server restarts.
# Type:    bool
# Default: <no value>
# AUTH_DEVELOPMENT_MODE=<no value>

###############################################################################
###############################################################################
# Connection to Corredor
#

###############################################################################
# Enable/disable Corredor integration
# Type:    bool
# Default: <no value>
# CORREDOR_ENABLED=<no value>

###############################################################################
# Hostname and port of the Corredor gRPC server.
# Type:    string
# Default: localhost:50051
# CORREDOR_ADDR=localhost:50051

###############################################################################
# Max delay for backoff on connection.
# Type:    time.Duration
# Default: 1m
# CORREDOR_MAX_BACKOFF_DELAY=1m

###############################################################################
# Max message size that can be recived.
# Type:    int
# Default: <no value>
# CORREDOR_MAX_RECEIVE_MESSAGE_SIZE=<no value>

###############################################################################
# Type:    time.Duration
# Default: <no value>
# CORREDOR_DEFAULT_EXEC_TIMEOUT=<no value>

###############################################################################
# Type:    time.Duration
# Default: 2s
# CORREDOR_LIST_TIMEOUT=2s

###############################################################################
# Type:    time.Duration
# Default: <no value>
# CORREDOR_LIST_REFRESH=<no value>

###############################################################################
# Type:    bool
# Default: <no value>
# CORREDOR_RUN_AS_ENABLED=<no value>

###############################################################################
# Type:    bool
# Default: <no value>
# CORREDOR_CLIENT_CERTIFICATES_ENABLED=<no value>

###############################################################################
# Type:    string
# Default: /certs/corredor/client
# CORREDOR_CLIENT_CERTIFICATES_PATH=/certs/corredor/client

###############################################################################
# Type:    string
# Default: ca.crt
# CORREDOR_CLIENT_CERTIFICATES_CA=ca.crt

###############################################################################
# Type:    string
# Default: private.key
# CORREDOR_CLIENT_CERTIFICATES_PRIVATE=private.key

###############################################################################
# Type:    string
# Default: public.crt
# CORREDOR_CLIENT_CERTIFICATES_PUBLIC=public.crt

###############################################################################
# Type:    string
# Default: <no value>
# CORREDOR_CLIENT_CERTIFICATES_SERVER_NAME=<no value>

###############################################################################
###############################################################################
# Environment
#

###############################################################################
# Type:    string
# Default: production
# ENVIRONMENT=production

###############################################################################
###############################################################################
# Events and scheduler
#

###############################################################################
# Enable eventbus scheduler.
# Type:    bool
# Default: <no value>
# EVENTBUS_SCHEDULER_ENABLED=<no value>

###############################################################################
# Set time interval for `eventbus` scheduler.
# Type:    time.Duration
# Default: 60s
# EVENTBUS_SCHEDULER_INTERVAL=60s

###############################################################################
###############################################################################
# federation
#

###############################################################################
# Federation enabled on system, it toggles rest API endpoints, possibility to map modules in Compose and sync itself
# Type:    bool
# Default: <no value>
# FEDERATION_ENABLED=<no value>

###############################################################################
# Federation label
# Type:    string
# Default: federated
# FEDERATION_LABEL=federated

###############################################################################
# Host that is used during node pairing, also included in invitation
# Type:    string
# Default: local.cortezaproject.org
# FEDERATION_HOST=local.cortezaproject.org

###############################################################################
# Delay in seconds for structure sync
# Type:    time.Duration
# Default: 2m
# FEDERATION_SYNC_STRUCTURE_MONITOR_INTERVAL=2m

###############################################################################
# Bulk size in fetching for structure sync
# Type:    int
# Default: 1
# FEDERATION_SYNC_STRUCTURE_PAGE_SIZE=1

###############################################################################
# Delay in seconds for data sync
# Type:    time.Duration
# Default: 1m
# FEDERATION_SYNC_DATA_MONITOR_INTERVAL=1m

###############################################################################
# Bulk size in fetching for data sync
# Type:    int
# Default: 100
# FEDERATION_SYNC_DATA_PAGE_SIZE=100

###############################################################################
###############################################################################
# Limits
#

###############################################################################
# Maximum number of valid (not deleted, not suspended) users
# Type:    int
# Default: <no value>
# LIMIT_SYSTEM_USERS=<no value>

###############################################################################
###############################################################################
# locale
#

###############################################################################
# List of compa delimited languages (language tags) to enable.
# In case when an enabled language can not be loaded, error is logged.
# 
# When loading language configurations (config.xml) from the configured path(s).
# 
# Type:    string
# Default: en
# LOCALE_LANGUAGES=en

###############################################################################
# One or more paths to locale config and translation files, separated by colon
# Type:    string
# Default: <no value>
# LOCALE_PATH=<no value>

###############################################################################
# Name of the query string parameter used to pass the language tag (it overrides Accept-Language header).
# Set it to empty string to disable detection from the query string.
# This parameter is ignored if only one language is enabled
# 
# Type:    string
# Default: lng
# LOCALE_QUERY_STRING_PARAM=lng

###############################################################################
# When enabled, Corteza all
# Type:    bool
# Default: <no value>
# LOCALE_RESOURCE_TRANSLATIONS_ENABLED=<no value>

###############################################################################
# Log locale related events and actions
# Type:    bool
# Default: <no value>
# LOCALE_LOG=<no value>

###############################################################################
# When enabled, Corteza reloads language files on every request
# Enable this for debugging or developing.
# Type:    bool
# Default: <no value>
# LOCALE_DEVELOPMENT_MODE=<no value>

###############################################################################
###############################################################################
# log
#

###############################################################################
# Disables JSON format for logging and enables more human-readable output with colors.
# 
# Disable for production.
# 
# Type:    bool
# Default: <no value>
# LOG_DEBUG=<no value>

###############################################################################
# Minimum logging level. If set to "warn",
# Levels warn, error, dpanic panic and fatal will be logged.
# 
# Recommended value for production: warn
# 
# Possible values: debug, info, warn, error, dpanic, panic, fatal
# 
# Type:    string
# Default: warn
# LOG_LEVEL=warn

###############################################################################
# Log filtering rules by level and name (log-level:log-namespace).
# Please note that level (LOG_LEVEL) is applied before filter and it affects the final output!
# 
# Leave unset for production.
# 
# Example:
# `warn+:* *:auth,workflow.*`
# Log warnings, errors, panic, fatals. Everything from auth and workflow is logged.
# 
# 
# See more examples and documentation here: https://github.com/moul/zapfilter
# 
# Type:    string
# Default: <no value>
# LOG_FILTER=<no value>

###############################################################################
# Set to true to see where the logging was called from.
# 
# Disable for production.
# 
# Type:    bool
# Default: <no value>
# LOG_INCLUDE_CALLER=<no value>

###############################################################################
# Include stack-trace when logging at a specified level or below.
# Disable for production.
# 
# Possible values: debug, info, warn, error, dpanic, panic, fatal
# 
# Type:    string
# Default: dpanic
# LOG_STACKTRACE_LEVEL=dpanic

###############################################################################
###############################################################################
# Messaging queue
#

###############################################################################
# Enable messagebus
# Type:    bool
# Default: <no value>
# MESSAGEBUS_ENABLED=<no value>

###############################################################################
# Enable extra logging for messagebus watchers
# Type:    bool
# Default: <no value>
# MESSAGEBUS_LOG_ENABLED=<no value>

###############################################################################
###############################################################################
# Monitoring
#

###############################################################################
# Output (log) interval for monitoring.
# Type:    time.Duration
# Default: 5m
# MONITOR_INTERVAL=5m

###############################################################################
###############################################################################
# Object (file) storage
#
# The MinIO integration allows you to replace local storage with cloud storage. When configured, `STORAGE_PATH` is not needed.
#


###############################################################################
# Location where uploaded files are stored.
# Type:    string
# Default: var/store
# STORAGE_PATH=var/store

###############################################################################
# Type:    string
# Default: <no value>
# MINIO_ENDPOINT=<no value>

###############################################################################
# Type:    bool
# Default: <no value>
# MINIO_SECURE=<no value>

###############################################################################
# Type:    string
# Default: <no value>
# MINIO_ACCESS_KEY=<no value>

###############################################################################
# Type:    string
# Default: <no value>
# MINIO_SECRET_KEY=<no value>

###############################################################################
# Type:    string
# Default: <no value>
# MINIO_SSEC_KEY=<no value>

###############################################################################
# `component` placeholder is replaced with service name (e.g system).
# Type:    string
# Default: {component}
# MINIO_BUCKET={component}

###############################################################################
# `component` placeholder is replaced with service name (e.g system).
# Type:    string
# Default: <no value>
# MINIO_PATH_PREFIX=<no value>

###############################################################################
# Type:    bool
# Default: <no value>
# MINIO_STRICT=<no value>

###############################################################################
###############################################################################
# Plugins
#

###############################################################################
# Enable plugins
# Type:    bool
# Default: <no value>
# PLUGINS_ENABLED=<no value>

###############################################################################
# List of colon seperated paths or patterns where plugins could be found
# Type:    string
# Default: <no value>
# PLUGINS_PATHS=<no value>

###############################################################################
###############################################################################
# Provisioning
#
# Provisioning allows you to configure a {PRODUCT_NAME} instance when deployed.
# It occurs automatically after the {PRODUCT_NAME} server starts.
# 
# [IMPORTANT]
# ====
# We recommend you to keep provisioning enabled as it simplifies version updates by updating the database and updating settings.
# 
# If you're doing local development or some debugging, you can disable this.
# ====
#


###############################################################################
# Controls if provision should run when the server starts.
# Type:    bool
# Default: <no value>
# PROVISION_ALWAYS=<no value>

###############################################################################
# Colon seperated paths to config files for provisioning.
# Type:    string
# Default: provision/*
# PROVISION_PATH=provision/*

###############################################################################
###############################################################################
# Seeder
#

###############################################################################
# Enable extra logging // fixme add some more description
# Type:    bool
# Default: <no value>
# SEEDER_LOG_ENABLED=<no value>

###############################################################################
###############################################################################
# Sentry monitoring
#
# [NOTE]
# ====
# These parameters help in the development and testing process.
# When you are deploying to production, these should be disabled to improve performance and reduce storage usage.
# 
# You should configure external services such as Sentry or ELK to keep track of logs and error reports.
# ====
#


###############################################################################
# Set to enable Sentry client.
# Type:    string
# Default: <no value>
# SENTRY_DSN=<no value>

###############################################################################
# Print out debugging information.
# Type:    bool
# Default: <no value>
# SENTRY_DEBUG=<no value>

###############################################################################
# Attach stacktraces
# Type:    bool
# Default: <no value>
# SENTRY_ATTACH_STACKTRACE=<no value>

###############################################################################
# Sample rate for event submission (0.0 - 1.0. defaults to 1.0)
# Type:    float64
# Default: <no value>
# SENTRY_SAMPLE_RATE=<no value>

###############################################################################
# Maximum number of bredcrumbs.
# Type:    int
# Default: <no value>
# SENTRY_MAX_BREADCRUMBS=<no value>

###############################################################################
# Set reported Server name.
# Type:    string
# Default: <no value>
# SENTRY_SERVERNAME=<no value>

###############################################################################
# Set reported Release.
# Type:    string
# Default: <no value>
# SENTRY_RELEASE=<no value>

###############################################################################
# Set reported distribution.
# Type:    string
# Default: <no value>
# SENTRY_DIST=<no value>

###############################################################################
# Set reported environment.
# Type:    string
# Default: <no value>
# SENTRY_ENVIRONMENT=<no value>

###############################################################################
###############################################################################
# Rendering engine
#

###############################################################################
# Gotenberg rendering container address.
# Type:    string
# Default: <no value>
# TEMPLATE_RENDERER_GOTENBERG_ADDRESS=<no value>

###############################################################################
# Is Gotenberg rendering container enabled.
# Type:    bool
# Default: <no value>
# TEMPLATE_RENDERER_GOTENBERG_ENABLED=<no value>

###############################################################################
###############################################################################
# Data store (database) upgrade
#

###############################################################################
# Enable/disable debug logging.
#     To enable debug logging set `UPGRADE_DEBUG=true`.
# Type:    bool
# Default: <no value>
# UPGRADE_DEBUG=<no value>

###############################################################################
# Controls if the upgradable systems should be upgraded when the server starts.
# Type:    bool
# Default: <no value>
# UPGRADE_ALWAYS=<no value>

###############################################################################
###############################################################################
# Delay system startup
#
# You can configure these options to defer API execution until another external (HTTP) service is up and running.
# 
# [ TIP ]
# ====
# Delaying API execution can come in handy in complex setups where execution order is important.
# ====
#


###############################################################################
# Delays API startup for the amount of time specified (10s, 2m...).
#     This delay happens before service (`WAIT_FOR_SERVICES`) probing.
# Type:    time.Duration
# Default: <no value>
# WAIT_FOR=<no value>

###############################################################################
# Show temporary status web page.
# Type:    bool
# Default: <no value>
# WAIT_FOR_STATUS_PAGE=<no value>

###############################################################################
# Space delimited list of hosts and/or URLs to probe.
#     Host format: `host` or `host:443` (port will default to 80).
# 
# [NOTE]
# ====
# Services are probed in parallel.
# ====
# Type:    string
# Default: <no value>
# WAIT_FOR_SERVICES=<no value>

###############################################################################
# Max time for each service probe.
# Type:    time.Duration
# Default: 1m
# WAIT_FOR_SERVICES_TIMEOUT=1m

###############################################################################
# Timeout for each service probe.
# Type:    time.Duration
# Default: 30s
# WAIT_FOR_SERVICES_PROBE_TIMEOUT=30s

###############################################################################
# Interval between service probes.
# Type:    time.Duration
# Default: 5s
# WAIT_FOR_SERVICES_PROBE_INTERVAL=5s

###############################################################################
###############################################################################
# Websocket server
#

###############################################################################
# Enable extra logging for authentication flows
# Type:    bool
# Default: <no value>
# WEBSOCKET_LOG_ENABLED=<no value>

###############################################################################
# Time before `WsServer` gets timed out.
# Type:    time.Duration
# Default: 15s
# WEBSOCKET_TIMEOUT=15s

###############################################################################
# Type:    time.Duration
# Default: 120s
# WEBSOCKET_PING_TIMEOUT=120s

###############################################################################
# Type:    time.Duration
# Default: 119s
# WEBSOCKET_PING_PERIOD=119s

###############################################################################
###############################################################################
# Workflow
#

###############################################################################
# Registers enabled and valid workflows and executes them when triggered
# Type:    bool
# Default: <no value>
# WORKFLOW_REGISTER=<no value>

###############################################################################
# Enables verbose logging for workflow execution
# Type:    bool
# Default: <no value>
# WORKFLOW_EXEC_DEBUG=<no value>

###############################################################################
# Defines the maximum call stack size between workflows
# Type:    int
# Default: <no value>
# WORKFLOW_CALL_STACK_SIZE=<no value>