Setup Wizard

On first launch — when no environments are configured — the application redirects to /setup. The wizard walks through four steps to get your instance ready.

TIP

The setup wizard only appears once. After completing it, you can modify all settings from the Settings page.

Step 1: Configure Environments

Add at least one environment with at least one Docker host.

Field	Required	Default	Description
Code	Yes	--	Short identifier, e.g. qa, stage, prod. Used in API paths.
Name	Yes	--	Display name, e.g. QA, Staging, Production.
Hosts	Yes	--	One or more Docker host addresses (hostname or IP).
Docker Port	No	2375	Docker API port on each host.
SSH User	Yes	--	User for SSH connections to the hosts.
Compose Directory	Yes	--	Path on the host where docker-compose files are stored.

You can add multiple environments. Click Add Environment for each one.

Example configuration:

Code:             qa
Name:             QA
Hosts:            qa-docker-01.internal, qa-docker-02.internal
Docker Port:      2375
SSH User:         deploy
Compose Directory: /opt/docker

WARNING

The backend must be able to reach each host on the Docker port (2375) and SSH port (22). Verify firewall rules and SSH key access before proceeding.

Step 2: Docker Registry (Optional)

Connect a private Docker registry for image browsing and deployment pulls.

Field	Description
Name	Display name for the registry
URL	Registry URL, e.g. https://registry.gitlab.com
Username	Registry username or access token name
Password	Registry password or access token

Skip this step if you only use public images or configure the registry later in Settings.

Step 3: License Activation (Optional)

Enter a license key to unlock Pro or Enterprise features, or skip to use the Community edition.

Feature comparison:

	Community	Pro	Enterprise
Environments & containers	Unlimited	Unlimited	Unlimited
Deployments & rollback	Yes	Yes	Yes
Alerting	--	Yes	Yes
Database tools	--	Yes	Yes
Redis management	--	Yes	Yes
API keys & webhooks	--	Yes	Yes
SSO / OIDC	--	--	Yes
Vulnerability scanning	--	--	Yes
Backup & restore	--	--	Yes
Audit log	--	--	Yes

You can activate or change your license at any time from Settings > License.

Step 4: Review & Confirm

A summary of all configured settings is displayed:

• Environments with their hosts and connection details
• Registry configuration (if provided)
• License edition

Review the summary and click Submit to initialize the application. The backend writes the configuration and creates the necessary database records.

API call: POST /api/setup/initialize

After initialization completes, you are redirected to the login page to create your first admin account.

Troubleshooting

Wizard does not appear The wizard only shows when no environments exist. If you have previously configured environments, go to Settings to modify them.

Cannot connect to Docker host Verify from the backend container:

# Test SSH connectivity
docker exec -it ops-backend ssh deploy@qa-docker-01.internal echo "OK"

# Test Docker API
docker exec -it ops-backend curl -s http://qa-docker-01.internal:2375/version

Setup fails on submit Check the backend logs for detailed error messages:

docker compose logs -f backend