# Docker-compose installation
Ontopic Studio can be deployed on a multitude of different systems. This flexibility is offered by the Docker technology. Docker allows packaging an application and everything it depends on, such as libraries and files, into a single file, called a Docker image. This file is independent of the environment it will be deployed on, be it Windows, MacOS, or Linux. A Docker image can be deployed on a simple PC, on servers, or in the cloud. In the case of Ontopic Studio, which consists of multiple applications, a small number of such images is needed. These images are deployed together through a Docker-compose script.
Prerequisites
Please contact us for obtaining the License key for installation. Contact Us (opens new window)
# Requirements
You need to have Docker and Git installed. If not, please visit the dedicated page.
Minimum and recommended versions
The minimum version of Docker-compose supported is 1.29.0, we recommend using a version 2.24.7+ (integrated in Docker Desktop 4.29.0+) to avoid encountering networking issues.
# Get the files
Change to the directory where to place the Ontopic Studio installation. In Windows, you have to do this in WSL2/Ubuntu.
Get the configuration files with git using the credentials you received by email, substituting the values <username> and <deploy-token>
git clone https://<username>:<deploy_token>@gitlab.com/ontopic/studio.git
cd studio/
By default you are getting the latest version (available in the main branch). If you want to run a specific version, execute this extra command (mind the v prefix):
git checkout v<version_number>
# Copy the license file
Copy the license you received by mail into the folder default-secrets/license, and make sure it is named user-license
# Login to the container registry
Read the container registry images, by signing in to the Gitlab Container Registry, substituting <username> and <deploy-token> with the given credentials:
docker login -u <username> -p <deploy-token> registry.gitlab.com
# Set the default configuration
Before using Ontopic Studio, it is necessary to configure its secrets and environment variables. Copy the .env.template file to .env file.
cp .env.template .env
# Advanced initialization
Ontopic Studio is ready to be tested with the default configuration. It uses a single user test and keeps data in Docker named volumes.
If you want to deploy Ontopic Studio in production, we recommend you to run the advanced initialization script for changing the default user and password, as well as having the data mounted on local directories to facilitate backups.
# Set up the materialization on object storage
If you want to enable materialization in Ontopic Studio, please visit the dedicated page.