FLOWLENZ - Quick Start
======================

What's in this folder:
  docker-compose.yml    - Container configuration
  start.sh              - Launcher for Linux / macOS (Intel)
  start.bat             - Launcher for Windows (double-click to run)
  README.txt            - This file

Prerequisites:
  Architecture: this release requires an x86-64 (amd64) machine.
    Apple Silicon (M1/M2/M3) Macs are not supported yet.

  Docker must be installed on your system.
  - Linux:   https://docs.docker.com/engine/install/
  - Windows: https://docs.docker.com/desktop/install/windows-install/
             When Docker Desktop asks, install WSL2 — open PowerShell as
             Administrator, run the command it provides, then restart Docker.
  - macOS:   https://docs.docker.com/desktop/install/mac-install/  (Intel Macs only)

Getting Started:

  1. Extract the downloaded zip into a folder of your choice.

  2. Run the start script:

     Linux / macOS (Intel):
       Open a terminal in this folder and run:
       chmod +x start.sh && ./start.sh

     Windows:
       Double-click start.bat

  3. The script will pull the latest Flowlenz image and start it.

  4. Open http://localhost:3000 in your browser.

  Manual Installation (if scripts don't work):
    1. Open a terminal / command prompt in this folder
    2. Run:  docker compose pull
    3. Run:  docker compose up -d
    4. Open http://localhost:3000

First-Time Setup:
  1. Enter your license key to activate Flowlenz
  2. Complete the Setup Wizard to configure your integrations
     (Jira, Azure DevOps, Git, Email, Slack, AI/LLM provider key, etc.)
  3. Start using the Flowlenz dashboard

Updating Flowlenz:
  Run these two commands in this folder:
    docker compose pull
    docker compose up -d
  Only changed components are downloaded — fast and lightweight.

Managing Flowlenz:
  Stop:       docker stop flowlenz
  Start:      docker start flowlenz
  Restart:    docker restart flowlenz
  View logs:  docker logs -f flowlenz
  Remove:     docker rm -f flowlenz

Full documentation: https://flowlenz.com/docs
Support: admin@techteamz.io
