Skip to content

Install on Docker

Talisman

Requirements

  1. Docker 24+
  2. Git repository
  3. Image registry
  4. OIDC / Keycloak installed

Installation

Create a Docker Compose file

Create a file named docker-compose.yaml in your project directory:

name: talisman

services:

  talisman:
    container_name: talisman
    image: talismancloud/talisman:${TAG}-oidc
    restart: unless-stopped
    ports:
      - "8080:8080"
    environment:
      - KARAVAN_GIT_REPOSITORY=${KARAVAN_GIT_REPOSITORY}
      - KARAVAN_GIT_USERNAME=${KARAVAN_GIT_USERNAME}
      - KARAVAN_GIT_PASSWORD=${KARAVAN_GIT_PASSWORD}
      - KARAVAN_GIT_BRANCH=main
      - KARAVAN_CONTAINER_IMAGE_REGISTRY=${KARAVAN_CONTAINER_IMAGE_REGISTRY}
      - KARAVAN_CONTAINER_IMAGE_REGISTRY_USERNAME=${KARAVAN_CONTAINER_IMAGE_REGISTRY_USERNAME}
      - KARAVAN_CONTAINER_IMAGE_REGISTRY_PASSWORD=${KARAVAN_CONTAINER_IMAGE_REGISTRY_PASSWORD}
      - KARAVAN_CONTAINER_IMAGE_GROUP=talisman
      - KARAVAN_DOCKER_NETWORK=talisman
      - KARAVAN_SERVICE_PORT=8080
      - karavan.keycloak.url=${KEYCLOAK_URL}
      - karavan.keycloak.realm=talisman
      - karavan.keycloak.frontend.clientId=frontend
      - karavan.keycloak.backend.clientId=backend
      - karavan.keycloak.backend.secret=${KEYCLOAK_SECRET}
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock"    
    labels:
      - "org.apache.camel.karavan/type=internal"    
    networks:
      - talisman

  reposilite:
    container_name: reposilite
    image: talismancloud/talisman-reposilite:${TAG}
    networks:
      - talisman   

networks:
  talisman:
    name: talisman

Set environment variables

Create a file named .env in your project directory:

TAG=4.5.0
KARAVAN_GIT_REPOSITORY=
KARAVAN_GIT_USERNAME=
KARAVAN_GIT_PASSWORD=
KARAVAN_CONTAINER_IMAGE_REGISTRY=
KARAVAN_CONTAINER_IMAGE_REGISTRY_USERNAME=
KARAVAN_CONTAINER_IMAGE_REGISTRY_PASSWORD=
KEYCLOAK_URL=
KEYCLOAK_SECRET=

Keycloak configuration

Talisman uses OIDC for authentication and authorization. Keycloak is an open source Identity Management platform that supports OIDC. Follow the Authorization documentation to configure Keycloak for Talisman Platform.