API Environment Secrets Reference
This page lists the environment variables required for local development of each backend API. All values are secrets — never commit real values to version control.
Each module contains .env.example templates with exactly these variables: copy them and fill in the values.
The local-learning, global-learning, and data-modeler modules live in the
Learning-APIs repository, the orch-api in the
Orchestration-API repository.
Quick Reference
| Variable | local-learning | global-learning | data-modeler | orch-api |
|---|---|---|---|---|
FLNET_GITLAB_ISSUE_TOKEN | ✓ | ✓ | ||
QUARKUS_OIDC_CREDENTIALS_SECRET | ✓ | ✓ | ||
QUARKUS_KEYCLOAK_ADMIN_CLIENT_CLIENT_SECRET | ✓ | ✓ | ||
QUARKUS_LANGCHAIN4J_OPENAI_API_KEY | ✓ | |||
UMLS_API_KEY | ✓ | |||
ORCH_DOCKER__GITLAB__REGISTRY_USERNAME | ✓ | |||
ORCH_DOCKER__GITLAB__REGISTRY_PASSWORD | ✓ | ✓ | ✓ | |
ORCH_DOCKER__GHCR__REGISTRY_USERNAME | ✓ | ✓ | ✓ | |
ORCH_DOCKER__GHCR__REGISTRY_PASSWORD | ✓ | ✓ | ✓ | |
PIPELINE_DOCKER_PASSWORD | ✓ | ✓ | ✓ | |
PIPELINE_REPO_TOKEN | ✓ | ✓ | ✓ |
local-learning
This file should be named: .env
FLNET_GITLAB_ISSUE_TOKEN=TOKEN
QUARKUS_OIDC_CREDENTIALS_SECRET=SECRET
QUARKUS_KEYCLOAK_ADMIN_CLIENT_CLIENT_SECRET=SECRET
Plus the shared orch secrets below, name this orch_secrets.env (template: orch_secrets.env.example).
global-learning
This file should be named: .env
QUARKUS_LANGCHAIN4J_OPENAI_API_KEY=TOKEN
FLNET_GITLAB_ISSUE_TOKEN=TOKEN
QUARKUS_OIDC_CREDENTIALS_SECRET=TOKEN
QUARKUS_KEYCLOAK_ADMIN_CLIENT_CLIENT_SECRET=TOKEN
Plus the shared orch secrets below, name this orch_secrets.env (template: orch_secrets.env.example).
data-modeler
This file should be named: .env
UMLS_API_KEY=TOKEN
orch-api
The orch-api requires the shared orch secrets listed below, plus the username for the GitLab registry.
This file should be named: .env
ORCH_DOCKER__GITLAB__REGISTRY_USERNAME=USERNAME
ORCH_DOCKER__GITLAB__REGISTRY_PASSWORD=TOKEN
# only needed while the pipeline image on ghcr.io is private
ORCH_DOCKER__GHCR__REGISTRY_USERNAME=USER
ORCH_DOCKER__GHCR__REGISTRY_PASSWORD=TOKEN
PIPELINE_DOCKER_PASSWORD=TOKEN
PIPELINE_REPO_TOKEN=TOKEN
Orch Secrets
Both local-learning and global-learning need these in addition to their own variables, in a file named orch_secrets.env.
They are used by compose-devservices.yml to start the orch-api as a Quarkus Dev Service.
The orch-api project itself also requires the same set in its .env.
ORCH_DOCKER__GITLAB__REGISTRY_PASSWORD=TOKEN
# only needed while the pipeline image on ghcr.io is private
ORCH_DOCKER__GHCR__REGISTRY_USERNAME=USER
ORCH_DOCKER__GHCR__REGISTRY_PASSWORD=TOKEN
PIPELINE_DOCKER_PASSWORD=TOKEN
PIPELINE_REPO_TOKEN=TOKEN