Installation

API Gateway can be installed in several ways.

Prerequisites

• Go 1.24.0 or later (for building from source)
• Docker (for containerized deployment)

Install from Go

The easiest way to install API Gateway is using Go:

go install github.com/go-zoox/api-gateway/cmd/api-gateway@latest

This will install the api-gateway binary to your $GOPATH/bin directory.

Build from Source

Clone the repository:

git clone https://github.com/go-zoox/api-gateway.git
cd api-gateway

Build the binary:

go build -o api-gateway ./cmd/api-gateway

Docker

Pull the Docker image:

docker pull gozoox/api-gateway:latest

Or build from Dockerfile:

docker build -t api-gateway .

Run with Docker:

docker run -d \
  -p 8080:8080 \
  -v $(pwd)/config.yaml:/etc/api-gateway/config.yaml \
  api-gateway

Docker Compose

Use the provided docker-compose.yml:

docker-compose up -d

Verify Installation

Check the version:

api-gateway --version

You should see the version number, for example: 1.4.5

Next Steps

• Quick Start - Create your first configuration
• Configuration - Learn about all configuration options