Getting Started with Relay

Relay is available as a Docker container, a compiled binary, or a cloud-hosted service. Choose what works best for your deployment model.

Docker

docker pull piqadot/relay:latest
docker run -p 8000:8000 piqadot/relay:latest

Binary

Download the latest release for your OS from the releases page. Extract and run:

./relay --config config.yaml

Create a config.yaml file pointing Relay at your upstream services:

upstream:
  - path: /api
    target: https://api.example.com
  - path: /auth
    target: https://auth.example.com

rateLimit:
  enabled: true
  perKey: 100 # requests per minute per API key
  perIp: 50 # requests per minute per IP

With Docker or the binary running, Relay listens on http://localhost:8000. Test it:

curl -H "X-API-Key: your-key" http://localhost:8000/api/users

Your upstream service receives the request, and Relay handles rate limiting, caching, and logging.

• Read about Relay's Features to learn more
• Check the Roadmap to see what's coming
• Configure advanced features like response caching and request tracing