Quick Start Setup

⚙️ Overview

This guide will walk you through setting up a small Germain UX environment, suitable for testing. Please note that this configuration is not recommended for production environments.

💻 Hardware Requirements

📦 Software Requirements

🚀 Installation

Download and extract the Germain UX package

cd /opt
wget https://germain-apm.s3.us-west-2.amazonaws.com/GermainAPM/2026/germainux-quickstart-2026.1-binary.tar.gz
tar xzf germainux-quickstart-2026.1-binary.tar.gz

Deploy your license key

cd germainux
echo <your license key> > config/license.key

Example:

Deploy client distribution files (optional)

wget https://germain-apm.s3.us-west-2.amazonaws.com/GermainAPM/2026/GermainAPMEngine-2026.1-6-binary.zip
unzip GermainAPMEngine-2026.1-6-binary.zip -d data/server/dist/2026.1

Update email settings (optional)

Update the email settings in the included common.properties file to match your SMTP server:

Start containers

docker-compose -f germainux.yaml up -d --force-recreate

This will start up the containers

1. inAPM/2026/GermainAPMEngine-2026.1-6-binary.zip
   unzip GermainAPMEngine-2026.1-6-binary.zip -d data/server/dist/2026.1
   

   
   

2. Update email settings (optional)
   Update the email settings in the included common.properties file to match your SMTP server:

   

   
   

3. Start containers

   docker-compose -f germainux.yaml up -d --force-recreate
   

   
   

   

   
   

   This will start up the containers necessary to run Germain UX and create the default schemas and OOTB config. The individual containers will generate log output under the data directory.

   

   
   

   This process will take a few minutes to complete - you should see the system CPU utilization spike and the drop once the services had completed their startup.

4. Verify that all containers are running:

   docker ps
   

   
   

   

   
   

5. Connect to the Germain UX workspace
   By default, the workspace can be accessed via http://<your ip>:8080/germainapm/workspace/ using the default credentials (admin / admin):
   

   

6. Stop containers

   docker-compose -f germainux.yaml down