OrkoviaFlow finds its path.
All resources
Get started5 min read

Getting started with Orkovia in 15 minutes

Run Orkovia on your own computer with Docker, sign in, deploy a first process and start an instance.

In short

  • 01

    Everything runs locally in Docker — nothing leaves your machine.

  • 02

    Two sites: the app (run and monitor) and Studio (design).

  • 03

    One command starts it; one command stops it and keeps your data.

Orkovia ships as a Docker bundle with a small start script. This guide takes you from an empty machine to a running process instance.

Install Docker
Start Orkovia
Sign in
Deploy
Start an instance

What you need

  • Docker Desktop (Windows or macOS) or Docker Engine with the Compose plugin (Linux), with at least 4 GB of memory
  • About 3 GB of free disk space
  • The Orkovia beta bundle and the registry username and token that come with it
Orkovia is in beta. The bundle and registry token are sent on request — use the Request a Demo page to ask for them.

Start Orkovia

1
Log in to the image registry (once)
Run ./orkovia.sh login on macOS or Linux, or orkovia.cmd login on Windows, and enter the username and token.
2
Start everything
Run ./orkovia.sh start (or orkovia.cmd start). The first start downloads about 1 GB, creates a .env file with random passwords, and prints your sign-in details.
3
Open the two sites
The app is at http://localhost:3000 and Studio is at http://localhost:3001. Sign in to each as admin with the password printed on first start.
./orkovia.sh login
./orkovia.sh start

Deploy your first process

1
Draw it in Studio
Create a diagram with a start event, a user task and an end event. Give the user task a candidate group.
2
Deploy
Use Studio's deploy wizard. The process now appears under Deployments in the app.
3
Start an instance
In the app, start an instance of the deployment, optionally with variables. The instance waits at the user task, which shows up in Tasks.
4
Complete the task
Claim and complete the task. The instance reaches the end event and is marked completed.

Everyday commands

CommandWhat it does
startStart everything
stopStop; your data is kept
statusShow what is running
logsFollow the logs
updateDownload newer images and restart
passwordShow the admin password again
backupWrite a database backup to the backups folder
resetStop and delete all data (asks you to confirm)
By default Orkovia only listens on your own machine. Before sharing it on a network, put HTTPS in front of it — otherwise passwords and tokens travel in clear text.

Use the API

The REST API is served from the same address as the app. Sign in to get a token, then send it as a bearer token on every other call.

curl -X POST http://localhost:3000/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "<your password>"}'

See it on your own process

Book a walkthrough with the Orkovia team.

Request a Demo

Keep reading

Get started4 min read

Importing models from Camunda 8

What carries over when you open a Camunda 8 (Zeebe) BPMN model in Orkovia, and what you need to fix by hand.

Read article
Design3 min read

Test a process before you deploy it: Play mode

Step through a diagram node by node inside the designer, choose gateway branches, and watch variables change — without deploying anything.

Read article
Build3 min read

Build without the backend: mocking service tasks

Give a service task a pretend response, delay and failure rate, so you can run the whole process before the real system or worker exists.

Read article