FluxGate Docs

Getting Started

High-Performance API Gateway for Microservices

Prerequisites

Before deploying FluxGate, ensure your environment meets the following requirements for optimal routing and TLS termination.

Linux, macOS, or Windows 10+

FluxGate runs natively on x86_64 and ARM64 architectures. Official Docker images are available for containerized deployments.

Go 1.21+ or Rust 1.75+

Required only if compiling from source. Pre-built binaries are recommended for production stability.

Available Ports 8080 & 8443

Default HTTP and HTTPS listeners. Adjust in `fluxgate.yaml` if conflicting with existing infrastructure services.

Installation

Deploy the FluxGate binary using our official CLI installer or download the pre-compiled release.

Run the following command in your terminal to fetch the latest stable release (v2.4.1) and place the binary in your system PATH.

The installer automatically verifies SHA-256 checksums and sets up systemd service files for Linux distributions.

              curl -fsSL https://install.fluxgate.io/v2 | sh
              sudo fluxctl init --mode gateway
              fluxctl status
            

First Request

Configure a basic routing rule and verify traffic forwarding to your upstream microservice.

Create a `routes.yaml` file in your `~/.fluxgate/` directory. Define a path-based rule pointing to your internal inventory service running on `10.0.0.12:3000`.

Once applied, FluxGate will handle connection pooling, header injection, and rate limiting automatically.

              apiVersion: fluxgate.io/v1
              kind: Route
              metadata:
                name: inventory-route
              spec:
                match:
                  - path: /api/v1/inventory
                backend:
                  address: 10.0.0.12:3000
                  protocol: HTTP1
              ---
              curl -X GET http://localhost:8080/api/v1/inventory/sku-4829 \
                -H "X-FluxGate-Trace: req-88a2" \
                -v
            

Next Steps

Expand your deployment with authentication, observability, and cluster management.

Configure OAuth2 & JWT Validation

Security

Integrate with Auth0, Okta, or HashiCorp Vault to enforce token-based access control on all ingress routes.

Enable Prometheus & OpenTelemetry

Observability

Export latency histograms, error rates, and request traces to your existing monitoring stack without code changes.