Quickstart Guide

Deploy FluxGate in 5 Minutes

High-Performance API Gateway for Microservices. Get your first routing pipeline live on localhost with Docker Compose.

1. Provision the Gateway Container

Pull the official FluxGate runtime and spin up an isolated environment using Docker Compose. No external dependencies required.

Create a new project directory and initialize the compose file. FluxGate exposes port 8090 for traffic ingress and 9090 for the admin dashboard.

Requires Docker Engine 24+ and Compose v2
Allocates 512MB RAM by default
Pre-configured with TLS termination stubs

version: '3.8'
services:
  fluxgate:
    image: fluxgate/edge:2.4.1
    container_name: fg-gateway-prod
    restart: unless-stopped
    ports:
      - "8090:8090"
      - "9090:9090"
    volumes:
      - ./fg-config:/etc/fluxgate/config
      - fg-logs:/var/log/fluxgate
    environment:
      - FG_LOG_LEVEL=info
      - FG_TELEMETRY_ENDPOINT=https://metrics.yourcorp.com

2. Define Routing Rules

FluxGate uses declarative YAML for service discovery and traffic shaping. Place this file in the mounted ./fg-config directory.

# gateway.yaml
gateway:
  name: fg-edge-01
  listen: ":8090"
  workers: 4

routes:
  - path: /api/v1/orders
    service: order-processor
    protocol: http
    upstream: "http://order-svc:3000"
    timeout: 5s
    rate_limit: 1000r/m

  - path: /api/v1/inventory
    service: stock-manager
    protocol: grpc
    upstream: "grpc://inventory-svc:50051"
    timeout: 3s
    circuit_breaker:
      threshold: 5
      window: 10s

The configuration above maps two internal microservices to public endpoints. FluxGate automatically handles connection pooling, load balancing across upstream replicas, and JSON payload validation.