🚀 Quick Start Setup
🧭 Overview
This guide deploys a small, single-host GermainUX environment using Docker Compose.
Use it for:
|
Use case |
|---|
|
Evaluation |
|
Initial configuration |
|
Demonstrations |
|
Development |
|
Functional testing |
This architecture is not recommended for production. It does not provide the sizing, security hardening, redundancy, backup, or high availability normally required for a production GermainUX deployment.
🔧 Requirements
🖥️ Hardware
The host must provide at least:
|
Resource |
Minimum |
|---|---|
|
CPU |
4 cores |
|
Memory |
32 GB RAM |
|
Storage |
100 GB available disk space |
Additional storage may be required depending on monitoring volume, Session Replay, and retention.
💿 Software
Install:
|
Package |
|---|
|
Docker |
|
Docker Compose |
|
|
|
|
Confirm that Docker is running:
docker --version
docker compose version
If your environment uses the legacy standalone Docker Compose command, replace docker compose with docker-compose in the commands below.
🛰️ Access and Network
You also need:
|
Requirement |
|---|
|
Administrator or root access to the host |
|
Outbound access to download the GermainUX packages |
|
A valid GermainUX license |
|
Access to the GermainUX Workspace port |
|
SMTP connectivity if email alerts or reports will be tested |
📦 Obtain the Package and License
Contact Germain Software to obtain:
|
Item |
|---|
|
The current GermainUX Quick Start package |
|
A license for the target host |
|
Optional GermainUX Engine distribution files |
Use the exact package and version provided for your deployment. Avoid combining packages from different GermainUX releases.
🚀 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
⚙️ Installation Steps
|
Step |
Command / Notes |
|---|---|
|
1 |
|
|
2 |
Update email settings (optional) Update the email settings in the included common.properties file to match your SMTP server:
|
|
3 |
Start containers 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: 
|
|
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 |
▶️ Next Steps
After validating the Quick Start environment:
|
Action |
|---|
|
Change all default credentials. |
|
Configure users and access permissions. |
|
Configure a monitored application. |
|
Deploy the required GermainUX Engine, Agent, profiler, or RUM component. |
|
Validate data collection and dashboards. |
|
Configure data privacy and retention. |
|
Plan a production architecture before expanding monitoring. |
For a production deployment, review:
ℹ️ Get Help
The Germain Team can help you set this up. Contact GermainUX Support.
Service: Enterprise
Supported Version: 2024.1