> ## Documentation Index > Fetch the complete documentation index at: https://docs.germainux.com/llms.txt > Use this file to discover all available pages before exploring further. # Quick Start Setup > Set up a GermainUX quick-start environment, starting with the minimum host requirements. Service `Enterprise` Availability 2024.1 > [card] [Requirements](#requirements) > > What you need first > [card] [Obtain the Package and License](#obtain-the-package-and-license) > > Match the exact release version > [card] [Installation](#installation) > > Download, extract and start **Quick Start Setup** **Use Quick Start for:** evaluation, initial configuration, demonstrations, development, and functional testing. > [!WARNING] > > 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: * Docker * Docker Compose * `wget` or another file-download utility * `unzip` Confirm that Docker is running: ```text theme={null} 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: * 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: * 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 GermainUX package ```text theme={null} 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 ```text theme={null} cd germainux echo > config/license.key ``` Example: ![Quick Start Setup: Installation](https://mintcdn.com/germain-ux/A5V4ExbdsH-e9Odt/images/main/quick-start-setup/image-20230519-184445.png?fit=max\&auto=format\&n=A5V4ExbdsH-e9Odt\&q=85\&s=494954d372ba1580481598c487f45344) Deploy client distribution files (optional) ```text theme={null} 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: ![Quick Start Setup: Update email settings (optional)](https://mintcdn.com/germain-ux/A5V4ExbdsH-e9Odt/images/main/quick-start-setup/image-20230519-195357.png?fit=max\&auto=format\&n=A5V4ExbdsH-e9Odt\&q=85\&s=03a4912795ec7f5671569f585cd2e9af) Start containers ```text theme={null} docker-compose -f germainux.yaml up -d --force-recreate ``` ![Quick Start Setup: Update email settings (optional), image 2](https://mintcdn.com/germain-ux/A5V4ExbdsH-e9Odt/images/main/quick-start-setup/image-20250807-173054.png?fit=max\&auto=format\&n=A5V4ExbdsH-e9Odt\&q=85\&s=38089e4f49fa03021079ff042882c15d) This will start up the containers ### Installation Steps | Step | Command / Notes | | - | - | | 1 | `inAPM/2026/GermainAPMEngine-2026.1-6-binary.zipunzip 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: ![Quick Start Setup: Update email settings (optional)](https://mintcdn.com/germain-ux/A5V4ExbdsH-e9Odt/images/main/quick-start-setup/image-20230519-195357.png?fit=max\&auto=format\&n=A5V4ExbdsH-e9Odt\&q=85\&s=03a4912795ec7f5671569f585cd2e9af) | | 3 | Start containers `docker-compose -f germainux.yaml up -d --force-recreate` ![Quick Start Setup: Update email settings (optional), image 2](https://mintcdn.com/germain-ux/A5V4ExbdsH-e9Odt/images/main/quick-start-setup/image-20250807-173054.png?fit=max\&auto=format\&n=A5V4ExbdsH-e9Odt\&q=85\&s=38089e4f49fa03021079ff042882c15d) This will start up the containers necessary to run GermainUX and create the default schemas and OOTB config. The individual containers will generate log output under the data directory. ![Quick Start Setup: Installation Steps, image 3](https://mintcdn.com/germain-ux/A5V4ExbdsH-e9Odt/images/main/quick-start-setup/image-20230519-201448.png?fit=max\&auto=format\&n=A5V4ExbdsH-e9Odt\&q=85\&s=c1e5494288213a2561aedf77d00482b6) 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` ![Quick Start Setup: Installation Steps, image 4](https://mintcdn.com/germain-ux/A5V4ExbdsH-e9Odt/images/main/quick-start-setup/image-20250807-173243.png?fit=max\&auto=format\&n=A5V4ExbdsH-e9Odt\&q=85\&s=cad8ebf138aeaa89843d4b0673a9b293) | | 5 | Connect to the GermainUX workspace By default, the workspace can be accessed via **http\://\:8080/germainapm/workspace/** using the default credentials (admin / admin): ![Quick Start Setup: Installation Steps, image 5](https://mintcdn.com/germain-ux/A5V4ExbdsH-e9Odt/images/main/quick-start-setup/image-20230614-183943.png?fit=max\&auto=format\&n=A5V4ExbdsH-e9Odt\&q=85\&s=b49e3cc541a371659f4cbf6c2fbf753f) | | 6 | Stop containers `docker-compose -f germainux.yaml down` | ## Next Steps After validating the Quick Start environment: * 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: * [Hardware Requirements](https://docs.germainux.com/main/hardware-requirements.md) * [Network Requirements](https://docs.germainux.com/main/network-requirements.md) * [Software Requirements](https://docs.germainux.com/main/software-requirements.md) * [Storage Requirements](https://docs.germainux.com/main/storage-requirements.md) ## Get Help > [card] [Contact GermainUX Support](https://docs.germainux.com/main/support.md) > > The GermainUX team helps you get up and running faster, empower your team, turn data into actionable insights, and optimize performance to deliver measurable business outcomes. > [card] Can't find what you need? > > Search all GermainUX docs with **Ctrl + K**, or use the feedback buttons at the bottom of this page to tell us what is missing. The content of this document is proprietary to GERMAIN SOFTWARE. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.