Skip to main content

Relixy Configurations

Server Configuration​

Basics​

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

export RELIXY_CONFIG_PATH=/path/to/relixy.yaml

If RELIXY_CONFIG_PATH is not set, the default path will be /etc/relixy/config.yaml.

Configure locations of resource files with definition.include. Relixy 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, Relixy considers the absolute location of the RELIXY_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 Relixy Server Reference

Resources​

See Resource Definitions for documentation on OpenAPI and RelyAuth resources.

Observability​

See Relixy Observability