Run the local Docker Compose environment

Product Zbix CRM · Version 1.2.0 · Source reviewed · Reviewed 28 October 2026
Audience Administrators and implementation teams · Deployment Release specific self hosted

Overview

The repository includes a Docker Compose environment for local development and testing. Its web service is exposed on loopback and its database and application services stay on the Compose network. This environment is distinct from the versioned Linux server distribution and the native Windows installer.

Purpose

Give engineers an isolated place to inspect or test a matching source release without changing an existing CRM installation.

Prerequisites

• An authorized development checkout of the intended source release.

• Docker Engine and Compose available, with sufficient host capacity.

• A separate development configuration and storage; no production credentials or restored customer data unless separately authorized.

Procedure

1. Read the checkout’s README, Compose definition and release notes before starting services. Confirm that the source revision matches the feature or issue being tested.

2. Choose a separate development directory and Compose project/storage plan. Check that its host port and volume names do not collide with an installed CRM environment.

3. For a new development environment, prepare configuration from the release’s example using protected local values. Preserve any existing configuration and volumes when resuming an established environment.

4. Use the documented local startup method. The PowerShell helper is scripts/start.ps1; the underlying Compose startup builds and starts the stack. Startup can apply migrations, so run it only against the authorized isolated database.

5. Open the local web address and check /api/health and /api/ready. Create the initial development administrator through the CLI’s hidden password prompt.

6. Use fictional test data only when explicitly needed. The seed-demo command is a data-writing operation and is not part of a read-only review.

7. Record the exact source revision, configuration profile and test dataset when reporting results. Do not treat local success as production deployment or capacity qualification.

Development startup on an authorized isolated checkout

docker compose up -d --build
docker compose ps

Create a development administrator through the hidden password prompt

docker compose exec api python -m app.cli create-admin --email admin@example.com

Expected result

A source-matched, isolated development stack is available without sharing the installed customer database or private-file volumes.

Important notes

• The documented local address is http://localhost:8088. Verify that it is unused before startup; do not displace another installation.

• A local HTTP profile does not establish production cookie, TLS, network or recovery readiness.

• Never use volume-removal or reset commands as routine troubleshooting for a persistent CRM database.

Troubleshooting

• If the host port is in use, identify the existing service and allocate an isolated test configuration instead of stopping it without authorization.

• If startup fails, inspect bounded Compose logs and readiness. Preserve configuration and data while diagnosing the failure.

• Escalate source/schema mismatches with the commit, expected migration and sanitized logs.

Related articles

• Choose a deployment model

• Complete the installation readiness review

• Monitor services jobs and recovery readiness