Utopia Knowledge Base Definitions
  • Welcome to Utopia University
  • 🔦Overview
    • How to Navigate the University
    • How is Utopia different
    • Features
    • Utopia Sync Website Links
  • 😁Contact Us
    • Open Chat Room
    • Contact Us
  • ⬇️Installation guide
    • Docker Compose Installation
      • Prerequisites
      • The Installation Configurator
        • Databases
        • S3 (Optional)
        • SMTP Details (Compulsory)
        • Adobe API Credentials (Optional)
        • Final steps to get your compose fle
      • Compose Installation
    • Kubernetes Installation
      • Prerequisites
      • The Installation Configurator
        • Databases
        • S3 (Optional)
        • SMTP Details (Compulsory)
        • Adobe API Credentials (Optional)
        • Ingress Naming (Compulsory)
        • Final steps to get helm chart
      • Using Helm to Install and Edit
      • Final Stage DNS setup
        • Setting up TLS cert
        • Third Party Service DNS Manager (like Cloudflare)
        • DNS Work-around while you get your cert ready
    • Cluster Craft
      • Basic Kubernetes install with microk8s
      • Basic Kubernetes install with microk8s and NFS storage
      • Updating Loadbalancer IP with Microk8s and Metallb
      • Installing Utopia in Azure
      • Testing SMTP server from a Kubernetes Cluster or a Container using telnet and openssl
      • Kubernetes Visibility
        • Kube CLI visibility with Lens or OpenLens
        • Prometheus and Grafana Monitoring
      • Syntax Cheat Sheet
        • Kubectl
        • Microk8s
        • Microceph
        • Mongodb Compass
          • _MONGOSH Terminal Commands
          • Query Commands
        • Shell Commands
  • 🖥️Product Guide
    • Integration Hub
      • Selecting your Organization
      • Menu Navigation
      • Data In
        • Collection Parameters
        • Document Lifespan Strategy
        • Source Connectors
          • Connector Modules
            • Empact Email Orders
            • File Transfer Protocol (FTP)
            • Generate Random Documents (Test)
            • HTTP REST Collection Source
            • Lotus 1-2-3 prn file
            • Microsoft Navision Collection
            • MySQL Query
            • Pick n Pay Supplier Orders
            • Post Office Protocol (POP3)
            • Secure File Transfer Protocol (SFTP) (SSH)
            • Internet Message Access Protocol (IMAP)
            • Shoprite Collection
            • SQL Server Query
            • StrategixNav Collection
            • Transaction Query
          • Web Hook Triggers
        • API Listeners
          • Document Capture
          • Document Query (External)
          • Document Query (Integrated)
          • Listener Security
      • Transform
        • Search Documents
        • The Designer Panel
        • The Designer view
        • Transform Stage Types
          • Filter
          • Lookup
          • Add Field
          • Projection
          • Unwind
          • JS / JSON
      • Data Out
        • Publisher Collection Parameters
        • Data Out Connector
          • API Collection Publisher
          • Do Nothing
          • File Transfer Protocol (FTP)
          • HTTP REST Collection Publisher
          • Message Transport Post
          • Microsoft Navision Publisher
          • PDF Document Emailer
          • Pick n Pay Invoices
          • Post Syspro QueryQuery
          • Post Syspro Transaction
          • Post Vector Orders
          • Secure File Transform Protocol (SFTP) (SSH)
          • Shoprite Invoice Publisher
          • SMTP Collection Publisher
          • SQL Server OPENJSON Publisher
          • SQL Server Query Publisher
          • StrategixNav Publisher
      • Validation
    • Organizations
    • Transaction Page
    • User Profile
    • Logging
    • Process Que Dashboard
    • Process Error Dashboard
    • New Functions
      • XML to Json using the Transform Designer
      • XML to Json using ChatGPT
      • Rest Connector JS Prescript
    • Release Notes
      • Microservices
        • 0.12.1622
        • 0.12.1630
  • ☕Use Cases
    • Follow Along Examples
      • Look-ups! no-code Transform Stage
        • Multi Field Look-ups! low-code Transform Stage
      • Rest Connector JS Prescript Example
        • Rest Connector JS PreScript Fault Finding Techniques
      • XML to Json using the Transform Designer
      • XML to Json using ChatGPT
    • Solution Discussions
      • Moditar: Increasing Integration Adoption using UtopiaSync
      • UtopiaSync the scalable no-code Backend?
      • UtopiaSync Security - How does it work?
      • UtopiaSync Custom Configuration
      • UtopiaSync Maintenance
  • 😁Case Studies
    • How Moditar drove efficiency for Meridian Wine Merchants using Utopia iPaaS
    • The journey to Spier Wine Farm's perfect eCommerce Integration
    • Integration journey to 100% automated with La Concorde Bakery
Powered by GitBook
On this page
  • Preparing for Installation:
  • Installation Process:
  • Making Changes to Your Configuration:
  • Completing the Installation:
  1. Installation guide
  2. Docker Compose Installation

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.

PreviousFinal steps to get your compose fleNextKubernetes Installation

Last updated 1 year ago

⬇️