Documentation

Install, run, and configure Flowlenz

Getting Started with Flowlenz

Last updated: May 2026

What You're Downloading

Flowlenz is packaged as a Docker image bundled with launcher scripts. Extract the zip, run one script, and Flowlenz is up — no manual installation required.

What's Inside the Download
  • flowlenz.tar — the Docker image
  • start.sh — launcher for Linux / macOS
  • start.bat — launcher for Windows (double-click to run)
  • docker-compose.yml — container configuration
  • 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

License Key

Your Flowlenz license key (received after download registration)

Installation

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

1

Extract the Download

Extract the flowlenz-latest.zipfile you downloaded. You'll get a flowlenz folder containing the Docker image and launcher scripts.

$ unzip flowlenz-latest.zip
$ cd flowlenz
2

Run the Start Script

The script will load the Docker image, start Flowlenz, and tell you when it's ready.

Linux / macOS
$ chmod +x start.sh && ./start.sh
Windows

Double-click start.bat in the extracted folder.

Once complete, you'll see:

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

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 two commands manually:

$ docker load -i flowlenz.tar
$ 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 (the key you received on the download page).

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
  • 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, 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.