Compose Installation

Final Steps for Installing Utopia with Docker Compose

Preparing for Installation:

  1. Ensure Docker is Running: Before starting the installation, check that Docker is actively running on your computer. Docker needs to be operational to create and manage the containers where Utopia will run.

  2. Connect to the Utopia Image Repository: Make sure you are connected to the Utopia image repository. This connection is necessary to access and download the required Utopia Docker images.

Installation Process:

  1. Navigate to the YML File:

    • Open your terminal. This is the application where you enter text commands (Command Prompt on Windows, Terminal on MacOS, etc.).

    • Use the terminal to navigate to the folder where your 'Utopia_Compose_Default.yml' file is located. This file contains the configuration settings for your Utopia installation.

  2. Run the Installation Command:

    • In the terminal, enter the following command: docker compose -f Utopia_Compose_Default.yml up

    • This command tells Docker to start the Utopia application using the settings specified in your YML file.

  3. Accessing Utopia:

    • Once Docker has set up Utopia, you can access the Utopia Application and begin creating integrations.

    • Open a web browser and go to the local address provided by Docker (usually something like localhost:port_number). The specific port number will be assigned by Docker and can be found in the terminal output.

Making Changes to Your Configuration:

If you need to make changes to your Utopia setup:

  1. Update the YML File:

    • Upload your current 'Utopia_Compose_Default.yml' file to the Installation Configurator on our website.

    • Make the necessary changes in the configurator, and then download the updated YML file.

  2. Apply the Changes:

    • First, bring down the current Utopia setup by entering docker compose -f Utopia_Compose_Default.yml down in your terminal. This command stops the Utopia containers.

    • Then, apply the new configuration by running the 'up' command again with the updated YML file: docker compose -f Utopia_Compose_Default.yml up

Completing the Installation:

Follow these steps to complete your Utopia installation and configuration. Remember, if you make changes to your setup, always bring down the current configuration before applying new settings with the updated YML file.

Last updated