The Installation Configurator

How to use the Installation Configurator in the Utopiasync members area and get docker compose file ready for installation.

Purpose of the Configurator:

The Installation Configurator is a tool designed to simplify the process of setting up our software. It assists you in creating a Docker Compose file, which is a yml (yaml) file specifying how Docker containers should be configured and run in your environment. This file is essential for customizing and deploying our software.

Initial Setup and Customization:

The Docker setup of our software is designed to be flexible and user-friendly. While extensive customization options are available post-installation (detailed in our Product Guide), this guide will focus on the essential requirements for installation, including both mandatory and optional elements.

Using the Configurator:

Manual vs. Automated Configuration:
- For those with technical expertise, there's an option to download and manually fill in the 'Utopia_Compose_Default.yml' file. This approach allows for direct editing of the configuration file.
- However, we recommend using the Installation Configurator for a more streamlined and guided experience, especially for those who are less familiar with technical YAML configurations.
Security Note:
- Please note that for security reasons, no details are stored on the configurator page. This ensures that your sensitive information remains confidential.
Editing an Existing Setup:
- If you already have a setup and need to make modifications, you can upload your existing 'Utopia_Compose_Default.yml' file onto the configurator page. This will auto-populate the configuration fields with your current settings, allowing for easy adjustments and re-download.
Starting from Scratch:
- If you are setting up for the first time, click the "Populate Account Details" button. This action will automatically input your account's access key and relevant details into the configuration file.
- Then select the Docker install radio button.

Check out this video on how to setup your access key

Once you have completed the configuration using the Installation Configurator, you will be provided with a Docker Compose file, tailored to your specific setup requirements. This file is then used to proceed with the installation and deployment of our software on your system.

PreviousPrerequisites NextDatabases

Last updated 1 year ago

Purpose of the Configurator:

Using the Configurator:

Manual vs. Automated Configuration:

For those with technical expertise, there's an option to download and manually fill in the 'Utopia_Compose_Default.yml' file. This approach allows for direct editing of the configuration file.
However, we recommend using the Installation Configurator for a more streamlined and guided experience, especially for those who are less familiar with technical YAML configurations.

Security Note:

Please note that for security reasons, no details are stored on the configurator page. This ensures that your sensitive information remains confidential.

Editing an Existing Setup:

If you already have a setup and need to make modifications, you can upload your existing 'Utopia_Compose_Default.yml' file onto the configurator page. This will auto-populate the configuration fields with your current settings, allowing for easy adjustments and re-download.

Starting from Scratch:

If you are setting up for the first time, click the "Populate Account Details" button. This action will automatically input your account's access key and relevant details into the configuration file.
Then select the Docker install radio button.

Check out this video on how to setup your access key