Skip to main content

RelyREST Configurations

Server Configuration​

Basics​

RelyREST loads its configuration from a YAML or JSON file specified by the RELY_CONFIG_PATH environment variable. Environment variables are applied on top of the file and take precedence.

export RELY_CONFIG_PATH=/etc/rely/config.yaml

If RELY_CONFIG_PATH is not set, the default path will be /etc/rely/config.yaml.

Configure locations of resource files with definition.include. RelyREST automatically loads JSON and YAML files in those locations. The location item can be either:

  • a file path, Glob patterns or folder. If the path is relative, RelyREST considers the absolute location of the RELY_CONFIG_PATH file as the root.
  • an HTTP URL.

You should exclude non-resource files in included folders with definition.include to avoid unexpected errors.

definition:
  include:
    - "./resources/*.yaml"
    - "https://example.com/api/resource.yaml"

Reference​

See RelyREST Server Reference

Resources​

See Resource Definitions for documentation on OpenAPI and RelyAuth resources.

Observability​

See Observability