Getting Started
Use this section to deploy Karvio, understand the object model, and complete the first end-to-end workflow.

Before You Begin
Karvio works best when project boundaries and execution rules are clear before users start adding cases and runs. Decide these items first:
| Decision | Why it matters |
|---|---|
| Project boundaries | Projects are the main security and data boundary. Use one project per product, application, or isolated delivery stream. |
| Suite structure | Suites become the long-term navigation model for the test repository. Keep them stable and feature-oriented. |
| Execution statuses | Agree when testers should use Failed, Blocked, Not Applicable, and In Progress. Consistent status use improves reporting. |
| Environment naming | Environment names appear in runs, dashboards, and history. Use names that include platform or target details when needed. |
| Defect workflow | Decide whether failures should create Jira issues immediately or only after triage. |
Setup Path
- Install Karvio with Docker Compose or Podman Compose.
- Log in as the bootstrap administrator if you enabled bootstrap during setup.
- Create or review the first project.
- Add users and assign project roles.
- Create suites and a small set of representative test cases.
- Create a run and record results.
- Configure Jira, JUnit import, notifications, and API keys when the core workflow is stable.
System Requirements
Karvio is distributed as containers. For an evaluation or small team deployment, you need:
- Docker Engine 24+ and Docker Compose v2.
- A Linux, macOS, or Windows host with at least 2 GB free RAM for evaluation. Production deployments should start at 2 vCPU and 4 GB RAM.
- Outbound internet access for pulling Docker images.
- A reachable hostname or reverse proxy if users will access Karvio outside the host machine.
- SMTP credentials if you want email notifications.
- Jira API credentials if you want defect creation and issue sync.
What to Read Next
| Goal | Page |
|---|---|
| Deploy the system | Installation |
| Complete the first workflow | Quick Start |
| Understand the data model | Key Concepts |
| Prepare project access | Users and Permissions |
| Connect automation results | JUnit XML Import |