Skip to main content

OpenTalk Setup Template version history

ot-setup v25.3.0

(found in OpenTalk v25.3.0)

Changelog​

Changed​

  • Update container image versions related to the product version v25.3.0.

Migration Guide OpenTalk Product Version v25.3​

This guide describes how to migrate from earlier OpenTalk product versions to v25.3. It is assumed that all subsequent commands are executed from the deployment directory /opt/opentalk.

1. Backup data and prepare migration​

Create a Dump of the controller database and remove old database files so that they do not interfere later. Run the following command to create a dump of the existing controller database. The dump file will be saved in /var/tmp/ with a timestamp in its filename. Feel free to change the destination path.

1.1 Backup/Dump controller database​

docker compose exec -T postgres pg_dump -U ot -d opentalk > /var/tmp/pg_dump_controller_db_$(date +%Y-%m-%d_%H-%M-%S).sql

1.2 Backup/Export Keycloak Realms​

docker compose exec -T keycloak /opt/keycloak/bin/kc.sh export --realm opentalk --file /opt/keycloak/data/import/export_realm_opentalk-$(date +%Y-%m-%d_%H-%M-%S).json

1.3 Backup MinIO and rename bucket​

Newer MinIO versions do not support bucket names containing an underscore ("_"). Previously, the default bucket name was s3_bucket and therefore must be renamed. Starting with OpenTalk v25.3, the default bucket name is now opentalk. If you are still using s3_bucket, perform the following steps to rename it to opentalk.

docker compose stop minio
tar -czf /var/tmp/minio-backup_$(date +%Y-%m-%d_%H-%M-%S).tar.gz ./data/minio
docker compose start minio

Rename MinIO Bucket:

docker compose exec -T minio sh -c "
  chmod +x /opt/bin/mc &&
  mc alias set local http://localhost:9000 \$MINIO_ROOT_USER \$MINIO_ROOT_PASSWORD &&
  mc mb local/opentalk &&
  mc mirror --overwrite local/s3_bucket local/opentalk &&
  mc rb --force local/s3_bucket
"

Change config to opentalk as bucket name:

sed -i 's/s3_bucket/opentalk/g' config/controller.toml .env

1.4 Stop Container Services​

docker compose down

1.5 Remove existing PostgreSQL and Keycloak data​

rm -rf data/pg_data/*
rm -rf data/kc_data/h2/*

2. Upgrade to Product Version v25.3.x​

2.1 Checkout git tag v25.3.x​

Replace tag with the appropriate target version.

git checkout v25.3.x

2.2 Start the PostgreSQL container with its new version​

Start only the PostgreSQL container to prepare for the restore:

docker compose up -d postgres

2.3 Restore the Database​

Restore the previously created dump into the new PostgreSQL 16 instance: (Replace the file with your actual dump filename.)

docker compose exec -T postgres psql -U ot -d opentalk < /var/tmp/pg_dump_controller_db_<timestamp>.sql

2.4 Start Keycloak und KC Database containers​

When Keycloak starts it automatically imports the previously exported realm JSON (see step 1.2) from its import directory and initializes the new database. No manual action required. For details on realm import behavior, consult the official Keycloak import/export documentation.

docker compose up -d keycloak postgres-kc

Check the Keycloak logs and wait until the Keycloak realm import has finished before proceeding to the next step.

2.5 Start All Services​

Finally, start all containers again:

docker compose up -d

ot-setup v25.2.2

(found in OpenTalk v25.2.2)

Changelog​

Changed​

  • Update container image versions related to the product version v25.2.2.

ot-setup v25.2.1

(found in OpenTalk v25.2.1)

Changelog​

Changed​

  • Update container image versions related to the product version v25.2.1.

ot-setup v25.2.0

(found in OpenTalk v25.2.0)

Changelog​

Changed​

  • Update container image versions related to the product version v25.2.0
  • Added Outlook Add-in

ot-setup v25.1.5

(found in OpenTalk v25.1.5)

Changelog​

Changed​

  • Update container image versions related to the product version v25.1.5.

ot-setup v25.1.4

(found in OpenTalk v25.1.4)

Changelog​

Changed​

  • Update container image versions related to the product version v25.1.4
  • Removed terdoc from docker-compose.yml

ot-setup v25.1.3

(found in OpenTalk v25.1.3)

Changelog​

Changed​

  • Update container image versions related to the product version v25.1.3.

ot-setup v25.1.2

(found in OpenTalk v25.1.2)

Changelog​

Changed​

  • Update container image versions related to the product version v25.1.2.

ot-setup v25.1.1

(found in OpenTalk v25.1.1)

Changelog​

Changed​

  • Update product version to v25.1.1

ot-setup v25.1.0

(found in OpenTalk v25.1.0)

Changelog​

Update product version to v25.1.0​

ot-setup v25.0.3

(found in OpenTalk v25.0.3)

Changelog​

Changed​

  • Update product version to v25.0.3

ot-setup v25.0.2

(found in OpenTalk v25.0.2)

Changelog​

Changed​

  • Update product version related to v25.0.2

ot-setup v25.0.1

(found in OpenTalk v25.0.1)

Changelog​

Changed​

  • Update container images and product version related to v25.0.1

ot-setup v25.0.0

(found in OpenTalk v25.0.0)

Changelog​

Changed​

  • Update product version v25.0.0.

ot-setup v24.21.0

(found in OpenTalk v24.21.0)

Changelog​

Changed​

  • Update container image versions related to the product version v24.21.0

ot-setup v24.13.0

(found in OpenTalk v24.13.0)

Changelog​

Changed​

  • Update container image versions related to the product version v24.13.0.
  • Introducing terdoc service

ot-setup v24.11.0

(found in OpenTalk v24.11.0)

Changelog​

Changed​

  • Update PRODUCT_VERSION to v24.11.0

ot-setup v24.10.0

(found in OpenTalk v24.10.0)

Changelog​

Changed​

  • Update PRODUCT_VERSION to v24.10.0
  • Update container image versions related to the product version v24.10.0.
  • Add documentation resources to the README
  • Add env variable WAITING_ROOM_DEFAULT_VALUE to the web-frontend

ot-setup v24.9.0

(found in OpenTalk v24.9.0)

Changelog​

Changed​

  • Update container image versions related to the product version v24.9.0.
  • Update README

ot-setup v24.8.1

(found in OpenTalk v24.8.1)

Changelog​

Changed​

  • Update container image versions related to the product version v24.8.1.

ot-setup v24.8.0

(found in OpenTalk v24.8.0)

Changelog​

Changed​

  • Update container image versions related to the product version v24.8.0.

ot-setup v24.7.1

(found in OpenTalk v24.7.1)

Changelog​

Changed​

  • Update container image versions related to the product version v24.7.1.

ot-setup v24.7.0

(found in OpenTalk v24.7.0)

Changelog​

Changed​

  • Update container image versions related to the product version v24.7.0.

ot-setup v24.6.1

(found in OpenTalk v24.6.1)

Changelog​

Changed​

  • Update container image versions related to the product version v24.6.1.

ot-setup v24.6.0

(found in OpenTalk v24.6.0)

Changelog​

Changed​

  • Update container image versions related to the product version v24.6.0.

ot-setup v24.5.0

(found in OpenTalk v24.5.0)

Changelog​

Changed​

  • Update container image versions related to the product version v24.5.0.

ot-setup v24.4.1

(found in OpenTalk v24.4.1)

Changelog​

Changed​

  • Update container image versions related to the product version v24.4.1.

ot-setup v24.4.0

(found in OpenTalk v24.4.0)

Changelog​

Changed​

  • Update container image versions related to the product version v24.4.0.

ot-setup v24.3.0

(found in OpenTalk v24.3.0)

Changelog​

Changed​

  • Docker Compose Profiles Changed:

    • Removed rarely used profile tags to support more flexible deployment scenarios.

  • Password Generation Enhancement:

    • Improved usage of pwgen for enhanced security and convenience.

  • Environment Variables Documentation:

    • Added detailed descriptions about environment variables for easier configuration.

  • Controller Configuration Enhancement:

    • Enabled controller.toml volume by default to streamline configuration management.

  • RabbitMQ Connection Fix:

    • Resolved issues with RabbitMQ connection environment variables

ot-setup v24.2.0

(found in OpenTalk v24.2.0)

Changelog​

Changed​

  • Update container image versions related to the product version v24.2.0.

ot-setup v24.1.1

(found in OpenTalk v24.1.1)

Changelog​

Changed​

  • Update container image versions related to the product version v24.1.1.
  • Janus Service:
    • Corrected environment variables for RabbitMQ connection for the Janus service.
  • README Update:
    • Updated README with information on configurations using environment variables.
  • Controller Configuration:
    • Enable mounting controller configuration files by default using Docker volume.

ot-setup v24.1.0

(found in OpenTalk v24.1.0)

Changelog​

Changed​

  • Update container image versions related to the product version v24.1.0.
  • Update README.md.