Skip to main content

Configuration

ReleaseFlow reads its configuration from RELEASEFLOW_* environment variables, which src/main/resources/application.properties maps onto Spring properties. The JAR, the container image, and ./mvnw spring-boot:run all read the same variables. Durations are ISO-8601 (PT10S, P7D), and lists are comma-separated.

Only the first table is required. Every other variable has a default that works for a single local deployment.

Required​

VariableWhat it is
RELEASEFLOW_DB_URLJDBC URL of a dedicated PostgreSQL database, for example jdbc:postgresql://localhost:5432/releaseflow
RELEASEFLOW_DB_USERNAMEDatabase user
RELEASEFLOW_DB_PASSWORDDatabase password
RELEASEFLOW_CREDENTIAL_MASTER_KEYBase64 of exactly 32 random bytes (openssl rand -base64 32). It encrypts every stored webhook secret, access token, and action secret. Startup fails without it, and losing it makes every stored secret unreadable

Never commit or share these values.

Web and session​

VariableDefaultWhat it does
RELEASEFLOW_SESSION_COOKIE_SECUREfalseMarks the session cookie Secure; set it to true whenever the application is served over HTTPS
RELEASEFLOW_INVITATION_TTLP7DHow long an invitation link stays usable
RELEASEFLOW_UI_LANGUAGESen,viInterface languages offered; the first is the fallback, and ?lang= accepts only these. See Interface language
RELEASEFLOW_OUTPUT_LANGUAGESen,viOutput languages suggested in forms. Any valid language tag is still accepted. See Output language
RELEASEFLOW_PUBLIC_BASE_URLhttp://localhost:8080The address this deployment is reached at. Every absolute public link is built from it, never from a request
RELEASEFLOW_PUBLIC_CHANGELOG_BASE_DOMAIN(empty)When set, also serves each Organization's changelog at https://{slug}.{domain}/. See Public changelog

Sources​

VariableDefaultWhat it does
RELEASEFLOW_WEBHOOK_MAX_BODY_BYTES1048576The largest delivery any provider may send
RELEASEFLOW_GITHUB_API_BASE_URLhttps://api.github.comWhere GitHub is called
RELEASEFLOW_GITHUB_TIMEOUTPT10SConnect and read timeout for GitHub
RELEASEFLOW_GITLAB_ALLOWED_HOSTSgitlab.comThe GitLab instances a source may name: host, host:port (HTTPS), or a full origin such as http://gitlab.internal:8080
RELEASEFLOW_GITLAB_TIMEOUTPT5SConnect and read timeout for GitLab
RELEASEFLOW_GITLAB_WEBHOOK_CLOCK_SKEWPT5MHow stale a signed GitLab delivery may be
RELEASEFLOW_LINEAR_API_BASE_URLhttps://api.linear.appWhere Linear's GraphQL API is called
RELEASEFLOW_LINEAR_TIMEOUTPT5SConnect and read timeout for Linear
RELEASEFLOW_LINEAR_WEBHOOK_CLOCK_SKEWPT60SHow far a Linear delivery's webhookTimestamp, the time Linear sent it, may be from the clock
RELEASEFLOW_JIRA_TIMEOUTPT10SConnect and read timeout for Jira
RELEASEFLOW_JIRA_POLL_INTERVALPT5MHow often each Jira project is read; a source whose next read is more than one interval late is shown as overdue
RELEASEFLOW_JIRA_POLL_OVERLAPPT10MHow far each read reaches back before the previous one
RELEASEFLOW_JIRA_DESCRIPTION_MAX_CHARACTERS8000The longest Jira description kept as evidence
RELEASEFLOW_JIRA_API_BASE_URL(empty)Local testing only: send every Jira call here instead of the source's own site

See Sources. A source's health has no setting of its own: a quiet source is measured over 90 days at the 90th percentile of its gaps, never below an hour and only once it has ten, and refused deliveries are written about once a second (ADR-0042).

Classification​

VariableDefaultWhat it does
RELEASEFLOW_SENSITIVE_PATHSsee belowReplaces the sensitive-path baseline. An invalid pattern or an empty list stops startup
RELEASEFLOW_CONTEXT_THRESHOLD60Context score (0–100) below which a change needs review
RELEASEFLOW_DUPLICATE_THRESHOLD0.82Similarity (0–1) at which two changes are recorded as possible duplicates

The default sensitive-path baseline is:

text
**/security/**,**/auth/**,**/*Security*,**/*Auth*,**/*Credential*,**/*Password*,
**/db/migration/**,**/*.sql,**/pom.xml,**/package.json,**/package-lock.json,
.github/workflows/**,**/Dockerfile,**/application*.properties,**/*.env*

See Changes and review.

AI​

AI is optional. Choose one provider and give it a key and a model. There is no default model; pick one that supports structured JSON output.

With OpenAI or DeepSeek, every classification request asks for the same temperature, 0 unless RELEASEFLOW_AI_TEMPERATURE says otherwise, which keeps one change's answer as stable as the model allows (see ADR-0035 and ADR-0038). An OpenAI reasoning model accepts only its default temperature and refuses a request that names one. It works without any setting: the refused request is sent once more without the temperature, and later requests leave it out until ReleaseFlow restarts, with one warning in the log (ADR-0039). Only a 400 whose error.param is temperature does this. A number set here falls back the same way. RELEASEFLOW_AI_TEMPERATURE=default leaves the temperature out from the first request, so the refusal never happens.

With Anthropic, requests use API version 2026-10-21, which takes no temperature, so none is sent whatever RELEASEFLOW_AI_TEMPERATURE says and Claude samples with its default (ADR-0045). On Claude 4.7 and later that is all the model ever accepted. On Claude 4.6 and earlier, classification runs at the default temperature, 1.0, rather than 0, so a change's answer, and the notes written from it, vary more between runs. The value is still checked at startup, and a number other than 0 logs one warning that it is ignored. The API key is sent as Authorization: Bearer.

VariableDefaultWhat it does
RELEASEFLOW_AI_PROVIDER(empty: no AI)openai, anthropic, or deepseek
RELEASEFLOW_AI_TIMEOUTPT60SBound on each AI request
RELEASEFLOW_AI_TEMPERATURE0Temperature of every classification request to openai and deepseek: a number from 0 to 2; default sends none, so the model uses its own. Unset or blank means 0. A model that refuses the temperature is sent none for the rest of the process. For anthropic it must be a number from 0 to 1 or default, and is never sent
RELEASEFLOW_OPENAI_API_KEY, RELEASEFLOW_OPENAI_MODEL(empty)OpenAI key and model
RELEASEFLOW_OPENAI_BASE_URLhttps://api.openai.com/v1OpenAI API address
RELEASEFLOW_ANTHROPIC_API_KEY, RELEASEFLOW_ANTHROPIC_MODEL(empty)Anthropic key and model
RELEASEFLOW_ANTHROPIC_BASE_URLhttps://api.anthropic.comAnthropic API address. A proxy or gateway here receives the key as Authorization: Bearer and anthropic-version: 2026-10-21
RELEASEFLOW_DEEPSEEK_API_KEY, RELEASEFLOW_DEEPSEEK_MODEL(empty)DeepSeek key and model
RELEASEFLOW_DEEPSEEK_BASE_URLhttps://api.deepseek.comDeepSeek API address

Startup fails when the selected provider lacks its key or model, when the provider name is unknown, when a provider's key or model is set while RELEASEFLOW_AI_PROVIDER is empty, or when RELEASEFLOW_AI_TEMPERATURE is neither default nor a number in the selected provider's range; the message names the variable and the range. See AI classification and summaries.

Translation​

VariableDefaultWhat it does
RELEASEFLOW_TRANSLATION_PROVIDERdisableddeepl turns on translation of release notes. A value other than disabled or deepl stops startup, and so does disabled while RELEASEFLOW_DEEPL_API_KEY is set
RELEASEFLOW_TRANSLATION_TIMEOUTPT30SBound on each translation request
RELEASEFLOW_DEEPL_API_KEY(empty)DeepL key; a key ending in :fx uses the free API. Required with deepl, and a key set while the provider is not deepl stops startup, so turning translation off means clearing the key too. Each Organization with a glossary uses one of the account's DeepL glossaries, and an API Free plan holds one
RELEASEFLOW_DEEPL_BASE_URL(empty)Overrides the host chosen from the key

See Release note languages.

Automation​

VariableDefaultWhat it does
RELEASEFLOW_AUTOMATION_TIMEOUTPT10SBound on every delivery that leaves the application
RELEASEFLOW_AUTOMATION_EMAIL_FROM(empty)Sender address. Without it and an SMTP host, an email action cannot be enabled
RELEASEFLOW_SMTP_HOST(empty)SMTP server
RELEASEFLOW_SMTP_PORT587SMTP port
RELEASEFLOW_SMTP_USERNAME, RELEASEFLOW_SMTP_PASSWORD(empty)SMTP credentials
RELEASEFLOW_SMTP_AUTHfalseUse SMTP authentication
RELEASEFLOW_SMTP_STARTTLSfalseUse STARTTLS
RELEASEFLOW_SLACK_ALLOWED_HOSTShooks.slack.com,hooks.slack-gov.comThe only origins a Slack webhook URL may name
RELEASEFLOW_NOTION_API_BASE_URLhttps://api.notion.comWhere Notion is called
RELEASEFLOW_NOTION_VERSION2026-03-11The Notion API version pages are written against. Change it only together with the body the application sends
RELEASEFLOW_CONFLUENCE_API_BASE_URL(empty)Local testing only: stand in for Confluence Cloud. The site is still checked, and recorded links still point at it
RELEASEFLOW_TEAMS_API_BASE_URL(empty)Local testing only: stand in for the Power Platform. The callback's path and signature are kept
RELEASEFLOW_ZENDESK_API_BASE_URL(empty)Local testing only: stand in for {subdomain}.zendesk.com. The subdomain is still checked
RELEASEFLOW_AUTOMATION_TRIGGER_DELAYPT15SHow often ReleaseFlow looks for a schedule or a reminder that has come due
RELEASEFLOW_AUTOMATION_TRIGGER_BATCH_SIZE20How many firings one of those passes may book
RELEASEFLOW_AUTOMATION_REMINDER_LOOKAHEADPT15SHow far ahead a reminder with no notice at all looks
RELEASEFLOW_AUTOMATION_WEBHOOK_CLOCK_SKEWPT5MHow far a signed call's timestamp may be from now
RELEASEFLOW_AUTOMATION_WEBHOOK_MAX_BODY_BYTES65536The largest signed call body

A Notion, Confluence, Microsoft Teams, or Zendesk action needs nothing from the deployment beyond these defaults: its token, callback URL, or client secret is entered for each action. See Automation.

Management port​

VariableDefaultWhat it does
RELEASEFLOW_MANAGEMENT_PORT8081Port of the Actuator health and Prometheus endpoints
RELEASEFLOW_MANAGEMENT_ADDRESS127.0.0.1Address that port binds to; move it only onto a private network
RELEASEFLOW_MANAGEMENT_HEALTH_MAILfalseInclude the SMTP server in health, for a deployment that cannot work without mail

See Operations.

Docker Compose and the quickstart​

These variables are read by docker-compose.demo.yml and the quickstart's compose.yaml, not by the application.

VariableDefaultUsed byWhat it does
RELEASEFLOW_HTTP_PORT8080bothHost port of the application, published on 127.0.0.1
RELEASEFLOW_DB_NAMEreleaseflowdemoDatabase name
RELEASEFLOW_GRAFANA_USERadmindemoGrafana administrator
RELEASEFLOW_GRAFANA_PASSWORD(required)demoGrafana administrator password
RELEASEFLOW_GRAFANA_PORT3000demoHost port of Grafana
RELEASEFLOW_PROMETHEUS_PORT9090demoHost port of Prometheus
RELEASEFLOW_IMAGE(written by the release)quickstartThe image, pinned to the digest a release pushed

Both Compose files forward only the variables listed in .env.example to the application: the database, the master key, the session cookie, the public changelog, AI (OpenAI, Anthropic, and DeepSeek keys and models), DeepL, and SMTP. Anything else keeps its application default inside those stacks; to change it, add it to the app service's environment in the Compose file. Forwarding an empty value instead would stop the application, which is why the sensitive paths, the review thresholds, and the interface languages are left out. The demo stack also sets RELEASEFLOW_MANAGEMENT_ADDRESS=0.0.0.0 inside its private network so Prometheus can scrape the application, and publishes nothing on that port.

Build and test only​

VariableUsed byWhat it does
RELEASEFLOW_VERSION, RELEASEFLOW_REVISIONDockerfile build argumentsThe version and commit stamped into the image by the Release workflow
RELEASEFLOW_E2E_BASE_URLPlaywrightPoints the browser suite at an application that is already running