Prerequisites

What do you need to get Utopia up and running with Docker Compose?

Docker Installation Guide

Docker is a popular tool that allows you to create, deploy, and run applications in containers. Containers can be thought of as a kind of lightweight, portable, and self-sufficient 'boxes' in which an application can run, along with everything it needs to operate (like libraries and other dependencies).

Requirements:

• Docker Software: Before starting, ensure that Docker is installed on your machine. Docker can be installed on various operating systems, and it allows you to run containers on your computer. Think of it as a tool that lets you package and run your application in a standardized way.

• Access to a Terminal: A terminal is a text-based interface (like Command Prompt on Windows, or Terminal on MacOS and Linux) that allows you to interact with your computer using Command Lines instead of a graphical interface.

Installation Process:

1. Install Docker: If you don't have Docker installed, follow the instructions at Docker Installation Guide. This guide will walk you through the steps to get Docker up and running on your PC.

2. Connect to the Utopia Image Repository (Repo):

   • What is a Repo? A repository (repo) is like a library or storage space where images (in Docker terms, 'images' are pre-built applications or services packaged with all their dependencies) are kept. You can think of it as a database of ready-to-deploy application containers.

   • Accessing the Repo: To use our Utopia sync services, you need to connect your Docker installation to our image repository. This is where we store the Docker images of our software.

   • Get Repo Details: Get the repo details here. These details will be used to connect your Docker to our repo.

3. Logging into the Repo:

   Before you can log into the Utopia image repository, you need to open your terminal. The terminal is a program that allows you to type in and execute commands. Here's how you can open it on different operating systems:

   On Windows:

   • Using Command Prompt: Press Win + R to open the Run dialog, type cmd, and press Enter. This will open the Command Prompt, which is a terminal-like interface in Windows.

   • Using PowerShell: You can also use PowerShell, a more powerful alternative to Command Prompt. Search for "PowerShell" in the Windows search bar and click on the app to open it

   On Linux:

   • The process to open a terminal varies slightly depending on the Linux distribution you are using. Generally, you can find it easily in your applications menu.

   • In most Linux distributions, you can press Ctrl + Alt + T to open the terminal directly.

4. Once you have the terminal open:

   • Run the command docker login registry.gitlab.com. This command initiates a login process to the specified registry (in this case, GitLab's registry where our repo is hosted).

   • Enter the credentials provided to log into the image repo.

Once these steps are completed, you'll be set up to pull images from our repository and deploy them using Docker on your machine.