Sign Up & Get Your API Key

Set up Fluxgate AI on your machine and get your first API key in under 5 minutes.

Prerequisites

Before you begin, make sure you have these installed on your computer:

Docker Desktop — Download from docker.com. This runs all the services.
Docker Compose — Included with Docker Desktop. Verify with docker compose version
Git — To clone the repository. Verify with git --version
4GB+ RAM — The platform runs 12 Docker containers

No coding required!

You do NOT need to know Python, Go, or JavaScript to use Fluxgate. The dashboard provides a visual interface for everything. The API key and commands below are copy-paste ready.

Step-by-Step Installation

Clone the Repository

Open your terminal (Command Prompt, PowerShell, or Mac Terminal) and run this command to download ACP:

git clone https://github.com/Anil175/fluxgate.git
cd fluxgate

Set Up Environment Variables

Copy the example environment file. This contains all the settings Fluxgate needs. You can customize it later.

cp .env.example .env

Start All Services

This command starts all 12 Docker containers (API, Dashboard, Database, Redis, Kafka, Workers, and more). The first time takes 3-5 minutes to download images.

docker compose up -d

Verify Everything is Running

Check that all containers are healthy. You should see 12 containers with status 'Up' or 'healthy'.

docker compose ps

Run Database Migrations

This creates all the database tables Fluxgate needs. Only needed on first setup.

docker compose exec api python -m shared.migrations.run

Seed Initial Data

This creates default roles, permissions, and a starter API key so you can begin using the platform immediately.

docker compose exec api python seed.py

Access the Dashboard

Open your web browser and go to:

http://localhost:3000

You should see the Fluxgate AI dashboard. This is your command center for managing all agents, tools, budgets, and more.

Get Your API Key

You need an API key to interact with Fluxgate programmatically (via cURL, Python, or any HTTP client).

Option A: Use the Dashboard

Open the Dashboard at http://localhost:3000/dashboard
Click the RBAC tab in the left sidebar
Go to the API Keys section
Click Generate Key
Copy and save your key — it will only be shown once!

Option B: Use the Seed Key

If you ran the seed script, a default API key was created. Check the seed output for the key, or look in the database:

# The seed script prints the API key. If you missed it, generate a new one via the dashboard.

Keep your API key safe!

Your API key provides full access to the Fluxgate API. Never share it publicly or commit it to git. Store it in environment variables or a secrets manager.

Test Your Connection

Verify everything is working by calling the health check endpoint:

Health Checkbash

curl http://localhost:8000/api/v1/health

You should see a response like:

Expected Responsejson

{"status": "healthy", "version": "1.0.0"}

Service URLs

Service	URL	Purpose
Dashboard	http://localhost:3000	Visual management interface
API	http://localhost:8000	REST API server
Gateway	http://localhost:8080	Rate-limited API gateway
Swagger UI	http://localhost:8000/docs	Interactive API documentation

Next Steps

Now that Fluxgate is running, head to the next page to create your first AI agent!

Overview

Create Your First Agent