Skip to main content

Quick start

Get Krado One running in under 5 minutes using the official Docker images.

Prerequisites

ToolMinimum version
Docker24+
Docker Composev2

1 — Create your compose file

Create a directory and download the compose file:

mkdir devx && cd devx
curl -O https://raw.githubusercontent.com/sir-vikk/devx-platform-enterprise/main/deploy/docker/docker-compose.yml
curl -O https://raw.githubusercontent.com/sir-vikk/devx-platform-enterprise/main/deploy/docker/nginx.conf

Or create docker-compose.yml manually — see Docker deployment for the full file.

2 — Configure

# Copy the sample env file (edit before starting for production)
curl -O https://raw.githubusercontent.com/sir-vikk/devx-platform-enterprise/main/.env.example
cp .env.example .env

For local testing the defaults work out of the box — SQLite is used automatically, no external services required.

To enable integrations (Jira, Slack, OpenAI, etc.) edit .env before starting. See Configuration reference.

3 — Start

docker compose up -d

This pulls and starts:

  • Backend API on port 8080
  • Frontend on port 80 / 5173

4 — First-time setup

Open http://localhost (or http://localhost:5173 if using the dev port). You will be presented with a two-step setup wizard:

Step 1 — Organization

FieldDescription
Organization nameDisplay name (e.g. "Acme Engineering")
SlugURL-safe identifier (e.g. acme)
DomainOptional email domain for org matching

Step 2 — Owner account

FieldDescription
UsernameLogin username
EmailOwner email address
PasswordMust be at least 6 characters

After submitting, you are automatically logged in as the org owner with full admin access.

tip

The setup wizard only appears on a fresh database. If you need to reset, remove the devx_data volume and restart:

docker compose down -v && docker compose up -d

5 — Explore

From Portal Home you can enter any of the enabled portals. Use Portal Config → Portal Settings to toggle individual sections.

Portal Home — all portals at a glance


What's next