Documentation

Install, run, and configure Flowlenz

Getting Started with Flowlenz

Last updated: May 2026

What You're Downloading

Flowlenz is distributed as a Docker image hosted on Docker Hub, bundled with lightweight launcher scripts. Download the starter kit, run one script, and Flowlenz pulls the latest image and starts up — no manual installation required.

What's Inside the Download
  • docker-compose.yml — container configuration (pulls image from Docker Hub)
  • start.sh — launcher for Linux / macOS
  • start.bat — launcher for Windows (double-click to run)
  • README.txt — quick start guide
Your Data Stays With You

Flowlenz runs entirely on your own infrastructure. Your project data, communications, and analytics never leave your network.

Prerequisites

Before you begin, make sure you have the following:

Operating System

Windows, macOS, or Linux — any OS that supports Docker

Docker

Docker Desktop (Windows/macOS) or Docker Engine (Linux), version 20.10+

System Resources

Minimum 8 GB RAM and 20 GB free disk space recommended

Installation

Follow these steps to get Flowlenz running. The entire process takes under 5 minutes.

Download Starter Kit(.zip, ~5 KB)

Contains docker-compose.yml + launcher scripts. The Docker image is pulled automatically on first run.

1

Extract the Download

Locate the downloaded flowlenz-latest.zip file (usually in your Downloads folder) and extract it.

Option A — Using your file manager (easiest)
  • Windows: Right-click the zip → Extract All → choose a folder
  • macOS: Double-click the zip file — it extracts automatically
  • Linux: Right-click → Extract Here
Option B — Using the terminal

Open a terminal in the folder where the zip was downloaded, and run:

$ unzip flowlenz-latest.zip

You'll get four files: docker-compose.yml, start.sh, start.bat, and README.txt.

2

Run the Start Script

The script will pull the latest Flowlenz image from Docker Hub, start the container, and tell you when it's ready.

Linux / macOS

Open a terminal in the extracted folder and run:

$ chmod +x start.sh && ./start.sh

You only need to run chmod +x start.sh && ./start.sh the very first time. After that, you can simply run ./start.sh to start Flowlenz.

Windows

Double-click start.bat in the extracted folder.

Once complete, you'll see:

✅ Flowlenz is running!
👉 Open http://localhost:3000

💡 Tip: You can re-run start.sh (or double-click start.bat) at any time — it will check for updates and restart Flowlenz. Your data is always preserved.

The script checks that Docker is installed and running before proceeding. If something is missing, it will tell you what to do.

?

Manual Installation

If the scripts don't work on your system, you can run the commands manually:

$ docker compose pull
$ docker compose up -d

Then open http://localhost:3000 in your browser.

Accessing Flowlenz

Once the container is running, open your web browser and navigate to:

http://localhost:3000

Or replace localhostwith your server's IP if accessing from another machine.

First-Time Setup

On your first visit, you will be prompted to activate Flowlenz by entering your license key.

Once activated, you will be redirected to the Setup Wizard where you can configure your integration keys:

  • Jira — API credentials for syncing projects and tickets
  • Azure DevOps — Personal access token for boards and repos
  • Git — Connect GitHub, GitLab, Bitbucket, or any self-hosted server for commit analysis
  • Email — IMAP/SMTP settings for email intelligence
  • AI / LLM — API key for the AI intelligence engine

After completing the setup wizard, you'll have full access to the Flowlenz dashboard with AI-analyzed data, insights, and recommendations across all your connected tools.

Ports & Networking

Flowlenz uses the following ports by default:

PortProtocolPurpose
3000HTTPWeb interface (frontend)
8000HTTPAPI (used by the frontend automatically)
Firewall Note
If you are running Flowlenz on a remote server, ensure ports 3000 and 8000 are open in your firewall so other machines on your network can access it.

To use a different port for the web interface, open the docker-compose.yml file in the extracted folder and change the first number in the port mapping:

# docker-compose.yml
services:
  flowlenz:
    ports:
      - "9000:3000"   # change 9000 to your preferred port
      - "8000:8000"   # API port (keep as-is)

Then restart Flowlenz by running the start script again, or docker compose up -d from the same folder.

Configuration

The Setup Wizard requires you to configure at least one integration key to proceed. To get the most out of Flowlenz, you'll want to configure all of them.

After the initial setup, you can always go back and manage your connections from the Settings page inside the platform. This is where you configure everything — Jira, Azure DevOps, Git, Email, Slack, your AI/LLM provider key, and more.

No config files to edit. Everything is done through the built-in web interface.

Quick Reference

Common Docker commands for managing your Flowlenz instance:

Stop Flowlenzdocker stop flowlenz
Start Flowlenzdocker start flowlenz
Restart Flowlenzdocker restart flowlenz
View logsdocker logs -f flowlenz
Remove containerdocker rm -f flowlenz
Check statusdocker ps --filter name=flowlenz
Need Help?

If you run into any issues, reach out to us at admin@techteamz.io. Please include the output of docker logs flowlenz in your message.