Skip to main content

Getting Started

Prerequisites​

  • Docker (recommended for containerized deployments).
  • An OpenAPI v3 (or Swagger v2) specification for your upstream API.

Running with Docker​

The quickest way to get started is with the official Docker image.

1. Create a server configuration file​

Create relixy.yaml in your project directory:

definition:
  include:
    - "./resources/*.yaml"

2. Create an OpenAPI resource​

Create resources/my-api.yaml:

version: v1
kind: OpenAPI
metadata:
  name: my-api
  description: "Proxies to my upstream API"
definition:
  ref: "https://petstore3.swagger.io/api/v3/openapi.json"
  settings:
    basePath: /v1/pets

3. Start the gateway​

docker run \
  -p 8080:8080 \
  -e RELIXY_CONFIG_PATH=/config/relixy.yaml \
  -v $(pwd):/config \
  ghcr.io/relychan/relixy:latest

Relixy is now running on port 8080. Requests to /v1/pets/* are proxied to the upstream PetStore API.

Everything else (port, TLS, telemetry, etc.) has sensible defaults. See Server Configuration for the full reference.

Next steps​