Gate Docker Deployment

Gate Docker Setup

This directory contains Docker configuration for the Gate (by Surkyl) API Gateway.

Quick Start

Using Docker Compose (Recommended)

# From apps/gate directory
docker-compose up -d

# Or from repository root
docker-compose -f apps/gate/docker-compose.yml up -d

The gateway will be available at http://localhost:8080

Using Docker CLI

# Build from repository root
docker build -f apps/gate/Dockerfile -t gate:latest .

# Run the container
docker run -d \
  --name gate \
  -p 8080:80 \
  gate:latest

Build Options

Standard Build (No Version in Server Header)

docker build -f apps/gate/Dockerfile -t gate:latest .

Server Header: Server: Gate (by Surkyl)

Build with Version Header

docker build \
  --build-arg GATE_FEATURES="version-header" \
  -f apps/gate/Dockerfile \
  -t gate:versioned .

Server Header: Server: Gate (by Surkyl)/0.1.0

Multi-Architecture Build

docker buildx build \
  --platform linux/amd64,linux/arm64 \
  -f apps/gate/Dockerfile \
  -t gate:latest \
  --push \
  .

Running

Basic Run

docker run -d \
  --name gate \
  -p 8080:80 \
  gate:latest

With Custom Environment Variables

docker run -d \
  --name gate \
  -p 8080:80 \
  -e RUST_LOG=gate=debug,hypers=debug,tower_http=debug \
  -e RUST_BACKTRACE=full \
  gate:latest

On Port 80 (Requires Privileges)

docker run -d \
  --name gate \
  -p 80:80 \
  --cap-add=NET_BIND_SERVICE \
  gate:latest

Health Check

The container includes a built-in health check that queries the /_health endpoint:

# Check container health
docker ps

# View health check logs
docker inspect gate | jq '.[0].State.Health'

Environment Variables

Variable	Default	Description
RUST_LOG	gate=info,hypers=info,tower_http=info	Logging configuration
RUST_BACKTRACE	1	Enable backtraces (0=off, 1=on, full=verbose)

Endpoints

Endpoint	Description
/_health	Health check endpoint (global route)
/*	All other routes return custom 404 page

Docker Compose Configuration

Development Setup

version: '3.8'

services:
  gate:
    build:
      context: ../..
      dockerfile: apps/gate/Dockerfile
      args:
        GATE_FEATURES: ''
    ports:
      - '8080:80'
    environment:
      - RUST_LOG=gate=debug,hypers=debug,tower_http=debug
      - RUST_BACKTRACE=full

Production Setup

version: '3.8'

services:
  gate:
    image: gate:latest
    container_name: gate-prod
    ports:
      - '80:80'
    environment:
      - RUST_LOG=gate=warn,hypers=warn,tower_http=warn
      - RUST_BACKTRACE=0
    restart: always
    cap_add:
      - NET_BIND_SERVICE

Image Details

Build Stages

1. Planner - Generates cargo-chef recipe for dependency caching
2. Builder - Builds dependencies and application binary
3. Runtime - Minimal Debian-based runtime image

Image Sizes

Image	Approximate Size
Builder Stage	~2.5 GB
Final Runtime	~80-120 MB
Compressed	~40-60 MB

Security Features

• ✅ Non-root user (gate:gate)
• ✅ Minimal runtime dependencies
• ✅ CA certificates included for HTTPS
• ✅ Health check endpoint
• ✅ No build tools in final image

Testing

Test Health Endpoint

# Using curl
curl http://localhost:8080/_health

# Using docker exec
docker exec gate curl -f http://localhost:80/_health

View Logs

# Follow logs
docker logs -f gate

# Last 100 lines
docker logs --tail 100 gate

Check Server Header

curl -I http://localhost:8080/_health | grep Server

Expected output:

• Without version-header: Server: Gate (by Surkyl)
• With version-header: Server: Gate (by Surkyl)/0.1.0

Troubleshooting

Port 80 Permission Denied

If you get permission errors binding to port 80:

1. Use port mapping to a higher port: -p 8080:80
2. Grant NET_BIND_SERVICE capability: --cap-add=NET_BIND_SERVICE
3. Run as root (not recommended): --user root

Build Failures

If cargo-chef build fails, try building without cache:

docker build --no-cache -f apps/gate/Dockerfile -t gate:latest .

Container Won’t Start

Check logs for errors:

docker logs gate

Common issues:

• Port already in use (change -p mapping)
• Insufficient memory (increase Docker memory limit)

Cleanup

# Stop and remove container
docker-compose down

# Or with Docker CLI
docker stop gate
docker rm gate

# Remove image
docker rmi gate:latest

# Clean up build cache
docker builder prune

CI/CD Integration

GitLab CI Example

build-gate:
  stage: build
  image: docker:24
  services:
    - docker:24-dind
  script:
    - docker build -f apps/gate/Dockerfile -t $CI_REGISTRY_IMAGE/gate:$CI_COMMIT_SHA .
    - docker push $CI_REGISTRY_IMAGE/gate:$CI_COMMIT_SHA

GitHub Actions Example

- name: Build Docker Image
  run: |
    docker build -f apps/gate/Dockerfile -t gate:${{ github.sha }} .
    docker tag gate:${{ github.sha }} gate:latest

Additional Resources

• Dockerfile Best Practices
• Docker Compose Documentation
• Rust Docker Guide