Ontopic Docs

# Upgrade

# Docker-compose

Make sure to backup before upgrading.

Stop the current Ontopic Suite version:

docker compose -f docker-compose.yml -f tutorial/docker-compose-tutorial.yml down

If you are in the main branch, pull the changes:

git pull

Otherwise, fetch the new tags and checkout the desired one:

git fetch
git checkout <new_version_number>

Start Ontopic Suite:

docker compose -f docker-compose.yml -f tutorial/docker-compose-tutorial.yml pull && docker compose -f docker-compose.yml -f tutorial/docker-compose-tutorial.yml up

# Migrate from studio (until version 2025.1.0) to suite repository (from version 2025.1.1)

To move projects from the studio repository to the suite repository, follow these steps based on your installation type:

# If you have run the initialization script

If you used the initialization script (init-configuration-local.sh) and have data stored in bind mounts:

  1. Starting from the suite repository

  2. Copy the volumes folder from the studio repository to the suite repository:

    sudo cp -a ../studio/volumes/. ./volumes

  3. Copy the default secrets folder to the new repository:

    sudo cp -a ../studio/default-secrets/. ./default-secrets

  4. Copy the .env file:

    sudo cp -a ../studio/.env ./

# If you kept the Docker volumes

If you used the standard installation with Docker named volumes:

  1. Starting from the suite repository

  2. Copy the default secrets folder:

    sudo cp -a ../studio/default-secrets/. ./default-secrets

  3. Copy the .env file:

    sudo cp -a ../studio/.env ./

  4. Copy the following Docker volumes from the studio installation:

    • studio_docs
    • studio_repos
    • studio_store-db
    • studio_git-config
    • studio_git-data
    • studio_git-mirror-db
    • studio_identity-data

  5. Create volumes

    • suite_docs
    • suite_repos
    • suite_store-db
    • suite_git-config
    • suite_git-data
    • suite_git-mirror-db
    • suite_identity-data

# AWS Marketplace

On the current server, create a snapshot of the second volume (/dev/xvdba). When creating a new EC2 instance from the Marketplace, in the section Configure storage, click on Advanced and select the snapshot you created for the second volume (/dev/xvdba). Check that the new EC2 instance is working and decommission the previous one.

# Migrate from studio 2024.1.4 to suite 2025.1.2

On the current server, create a snapshot of the second volume (/dev/xvdba). When creating a new EC2 instance from the Marketplace, in the section Configure storage, click on Advanced and select the snapshot you created for the second volume (/dev/xvdba).

Users and passwords will be preserved from the old instance.

Migration steps:

  1. Access the server via SSH

  2. Copy the configuration files:

    cd /mnt/persistent/etc
sudo cp -a ontopic-studio/. ontopic-suite

  3. Copy the data directories:

    cd /mnt/persistent/var/lib/
sudo cp -a ontopic-studio/. ontopic-suite
sudo cp -a ontopic-studio-configuration/. ontopic-suite-configuration/

  4. Restart the services:

    sudo systemctl restart ontopic-suite-configuration.service
sudo systemctl restart ontopic-suite.service

  5. Update user roles at http://<your-server>:8080:

    • For each user, update the username and password
    • Assign appropriate roles:
      • ots-admin for administrators
      • ots-project-creator for users who should have the ability to create new projects

# Desktop

A popup message will appear to inform the user about a new available version. The download and upgrade happens automatically in background.

# Migrate from Studio 2024.1.7 to Suite 2025.1.2

After installing Ontopic Suite, you can export the project in different ways:

# Manual export/import

  1. You can export your Ontopic Studio Projects by clicking on the button export project on the project list or on the dashboard.

  2. After closing Ontopic Studio and starting Ontopic Suite, you can create a new project with the data source connection and clicking on the button import project on the Dashboard.

# File system migration

Open the folder: %AppData%/OntopicStudio usually located at

C:\Users\<your user>\AppData\Roaming\OntopicStudio

Copy the folders docs, license and materialization-result (if present) to %AppData%/OntopicSuite.

Overwrite the folder if requested.

← Troubleshooting →