Skip to content

Environment Variables

Talisman Server reads each setting from an environment variable. Set them in your Docker Compose file or in the Kubernetes Deployment, usually from a Secret.

Environment

Variable Default What it sets
TALISMAN_ENVIRONMENT dev The environment this Server runs in. dev runs Control Plane and Studio Web; any other value runs Control Plane only.
TALISMAN_ENVIRONMENTS dev,test,prod The environments of your installation.
TALISMAN_TITLE Talisman Platform The title shown in the web interface.
TALISMAN_GAV rest.talisman.demo The Maven group ID of new projects.

Authentication

Variable Default What it sets
PLATFORM_AUTH session session: sign in as admin with a password. oidc: sign in with Keycloak (also set QUARKUS_OIDC_TENANT_ENABLED=true).
PLATFORM_PASSWORD — The admin password with session authentication. Always set it.
KARAVAN_KEYCLOAK_URL http://keycloak:8079 Keycloak URL.
KARAVAN_KEYCLOAK_REALM talisman Keycloak realm.
KARAVAN_KEYCLOAK_FRONTEND_CLIENTID frontend Client ID of the frontend client.
KARAVAN_KEYCLOAK_BACKEND_CLIENTID backend Client ID of the backend client.
KARAVAN_KEYCLOAK_BACKEND_SECRET — Secret of the backend client.

See Authorization for the Keycloak setup.

Database

Talisman Server stores its data in PostgreSQL.

Variable Default What it sets
TALISMAN_DATASOURCE_URL jdbc:postgresql://postgres:5432/talisman JDBC URL of the database.
TALISMAN_DATASOURCE_USERNAME talisman Database user.
TALISMAN_DATASOURCE_PASSWORD — Database password.
TALISMAN_DATASOURCE_SCHEMAS public Database schema.

Git

Variable Default What it sets
KARAVAN_GIT_REPOSITORY http://gitea:3000/talisman/talisman.git The repository that holds your projects.
KARAVAN_GIT_USERNAME talisman Git user.
KARAVAN_GIT_PASSWORD — Git password or access token.
KARAVAN_GIT_BRANCH main The branch Talisman Server reads and commits to.
KARAVAN_GIT_PULL_INTERVAL off How often to pull changes others pushed and reload the affected projects: off, or a duration such as 1m.
TALISMAN_GITEA_INIT false true creates the user and repository in the bundled Gitea on first start (demo setup).

See Git.

Image registry

Server Build pushes project images to this registry.

Variable Default What it sets
KARAVAN_CONTAINER_IMAGE_REGISTRY registry:5000 Registry host and port.
KARAVAN_CONTAINER_IMAGE_GROUP talisman Group (namespace) of project images.
KARAVAN_CONTAINER_IMAGE_REGISTRY_USERNAME — Registry user.
KARAVAN_CONTAINER_IMAGE_REGISTRY_PASSWORD — Registry password.
KARAVAN_CONTAINER_IMAGE_REGISTRY_INSECURE true Allow a plain HTTP or self-signed TLS registry. Set false for a registry with a trusted certificate.
KARAVAN_CONTAINER_IMAGE_REGISTRY_CA_CONFIGMAP — Kubernetes only: the ConfigMap that holds the registry's CA certificate.
KARAVAN_CONTAINER_IMAGE_REGISTRY_CA_KEY ca.crt The key of the certificate in that ConfigMap.

Developer mode

Variable Default What it sets
KARAVAN_DEVMODE_IMAGE talismancloud/talisman-devmode:${tag} The image for developer mode and Server Build. Set it to pull from your own registry.

See Developer Mode.