Install

Flow Metrics runs in a container, so there is very little to install. You need a container engine to run it and Git to get the code. Everything else — your password, your tracker connection, your boards — is set up later in the browser, not here.

That is the whole prerequisite list. The rest of this page is just the fastest way to satisfy it on your machine.

Get the code

Repository: https://gitlab.com/tomasz-feliksik/flow-metrics-base

git clone https://gitlab.com/tomasz-feliksik/flow-metrics-base.git
cd flow-metrics-base

When prompted, use token as the username and your access token as the password. Later, git pull brings you up to date.

Setting up: two ways

Hand it to your AI assistant

Your machine is specific — a particular OS, package manager, and a real answer to “Docker or Podman here?” that depends on your setup. Adapting to that is exactly what an assistant is good at and exactly what a written tutorial is bad at, which is why we lead with it rather than printing six versions of the same instructions.

Paste this into Claude Code, Cursor, Copilot, or any assistant that can run commands on your machine:

I want to run Flow Metrics on this machine.

1. Check what I already have: a container engine with Compose v2
   (`docker compose version` or `podman compose version`) and Git.
   Tell me what you found before you change anything.

2. Install only what is actually missing, in the way that fits this
   machine — my OS, my package manager, and whether Docker or Podman is
   the better fit here. Show me each command before you run it.

3. Clone https://gitlab.com/tomasz-feliksik/flow-metrics-base.git and open
   flow-metrics-server/README.md.

4. Follow that README to start the server, then tell me the exact URL to
   open and what I will be asked for on the first screen.

Don't reinstall anything I already have, and stop and ask me if a step
needs a decision that is mine to make.

It reports before it acts, installs only what is missing, and leaves the decisions with you. If you would rather read first and run later, ask it to explain the plan without executing.

Do it yourself

No assistant, or you would simply rather do it by hand? It is three steps.

1. Install a container engine — either one works; you do not need both.

Docker Desktop and Podman Desktop include Compose. On Linux, make sure you install the Compose plugin alongside the engine — Flow Metrics needs Compose v2.

2. Install Git — git-scm.com/downloads. Already present on most Linux and macOS systems.

3. Get the code and start your product — clone as shown above, then follow Flow Metrics Server.

Check it worked

git --version
docker compose version    # or: podman compose version

Two version numbers and you are ready. If docker compose version errors but docker --version works, you have the engine but not Compose v2 — install the Compose plugin.

Next

Go to Flow Metrics Server. It takes you from here to charts in the browser, and has the same “hand it to your assistant” option for the last few steps.

Notes

Windows and the .ps1 runners. Each product ships a PowerShell runner, and stock Windows refuses to run .ps1 files (running scripts is disabled on this system), opening them in Notepad instead. You do not need to change that policy: every runner a product ships has a .cmd launcher of the same name beside its .ps1, which runs the script with -ExecutionPolicy Bypass for that launch only and forwards whatever arguments you pass. Use the .cmd and the commands in the docs work as written. If you would rather call the .ps1 yourself, either run it from a PowerShell window that allows scripts, or launch it as powershell -ExecutionPolicy Bypass -File .\<script>.ps1 [args].

Windows without Docker Desktop. If licensing rules it out, run Flow Metrics inside WSL: wsl --install -d Ubuntu from PowerShell, restart, then install Podman inside Ubuntu and work from there. Your assistant can do this whole path with the prompt above.

Nix / NixOS. This repository ships a flake — nix develop gives you everything, or add use flake to .envrc and run direnv allow.

Podman and docker compose. Commands throughout the docs are written as docker compose. On Podman, substitute podman compose — everything else is identical.

Support

Contact your license provider for support, access tokens, and product inquiries.