Running Dataedo Portal with Docker Compose

This tutorial provides a step-by-step guide to running Dataedo Portal and Dataedo Agent using Docker Compose. If this approach doesn’t meet your needs, check other installation guides.

Prerequisites

To proceed with Docker deployment, first you'll need to install Docker and Docker Compose and Git.

useful tip

Docker Compose is included with Docker Desktop on Windows and Mac.

Deployment instructions

Step 1: Clone Docker Compose files

To deploy an environment that includes Dataedo Portal and Dataedo Agent, run the following command to clone the necessary files:

git clone --single-branch --branch with-agent https://gitlab.com/dataedo/docker-compose.git dataedo

This will create a new folder named dataedo in your current directory with all required files.

useful tip

You can also deploy the environment with different components depending on your needs. Use git clone with the corresponding branch to select the configuration you want.

Available configurations:

Dataedo Portal + Agent

git clone --single-branch --branch with-agent https://gitlab.com/dataedo/docker-compose.git dataedo

Dataedo Portal + SQL Server + Dataedo Agent

git clone --single-branch --branch with-agent-and-sql https://gitlab.com/dataedo/docker-compose.git dataedo

Dataedo Portal + SQL Server

git clone --single-branch --branch with-sql-express https://gitlab.com/dataedo/docker-compose.git dataedo

Dataedo Portal only (no Agent or SQL Server)

git clone https://gitlab.com/dataedo/docker-compose.git dataedo

Step 2: Navigate to the /dataedo directory

Move into the newly created folder:

cd dataedo

Step 3: Configure your Docker environment

1. Edit the Docker .env file

   useful tip

   If you have an SQL repository configured, update the .env file with the repository details. If you don’t, you can create it later using Docker GUI.

2. Change the default port (optional) By default, Dataedo Portal runs on port 80. To use a different port, modify the docker-compose.yml file.

Step 4: Launch Dataedo Portal

Dataedo Agent and SQL Repository

Before starting the Dataedo Agent, ensure that the SQL repository is available and accessible. The Agent tries to connect up to three times and stops retrying until restarted. If you later add or update the repository, update the configuration and restart the Agent in its deployment environment using:

sudo docker compose down && sudo docker compose up -d

Launch the application (Dataedo Portal and Agent) using Docker Compose:

sudo docker compose up -d

Step 5: Access Dataedo Portal

Once the setup completes, open your browser and visit your Dataedo Portal. The default URL is http://localhost:80.

Need help?

If you run into any problems or have questions, reach out to Dataedo support.