Quickstart Guide

Open-source API gateway for microservices

01 / Prerequisites

System Requirements

Verify your host environment before initiating the deployment pipeline.

Linux x86_64 kernel 5.15+ or macOS Sonoma
Docker Engine 24.0.5+ with Compose plugin v2.20
Minimum 2 vCPU and 4GB RAM dedicated to the gateway process
Open inbound ports 8443 (TLS termination) and 9090 (Prometheus metrics)
Valid FQDN or IP address for upstream service discovery

02 / Deployment

One-Command Install

Fetch, configure, and start the FluxGate daemon in under 30 seconds.

curl -fsSL https://dl.fluxgate.dev/v2.4.1/install.sh | sudo sh -s -- --repo stable --route-table rt-alpha

The installer automatically provisions the systemd service, generates a self-signed TLS certificate for localhost, and initializes the rt-alpha routing table with three default upstreams. Configuration persists at /etc/fluxgate/config.yaml.

03 / Validation

Health Endpoint Verification

Confirm the control plane and data plane are responding.

curl -s http://localhost:8443/health | jq .

Expected response: {"status":"healthy","uptime":"12s","active_routes":3,"memory_usage":"84MB","version":"2.4.1"}. If the payload returns 200 OK, the gateway is ready to accept traffic. Metrics are exposed at http://localhost:9090/metrics for immediate Prometheus scraping.

Rate Limiting & Quotas

Configure token bucket algorithms per tenant using the built-in Redis adapter.

TLS & mTLS Termination

Automate certificate rotation with Let's Encrypt or inject client certificates for zero-trust mesh.

OAuth2 & JWT Validation

Parse bearer tokens, validate signatures against JWKS endpoints, and map scopes to routes.

View API Reference

Join DevOps Slack