The config plugin is an essential component in RoadRunner, responsible for parsing configuration files and environment variables. It serves as a central hub for managing configurations for the plugins and RoadRunner server itself.
The RoadRunner configuration file should be formatted using YAML or JSON. Each configuration file must include
version at the top, indicating the format's version. The currently supported configuration version is version 3.
The configuration version is not synonymous with the RoadRunner (RR) version. The configuration version and RR version have separate versioning systems.
Example of a YAML configuration file:
version: '3' # ... other config values
Version numbers are strings, not numbers. For example,
version: "3"is correct, but
version: 3is not.
The compatibility matrix provides information about the supported configuration versions for different RoadRunner versions.
|RR version||Configuration version|
|<=2.6.x||Doesn't support versions|
*non-versioned: configuration used in the 2.0.x-2.6.x releases.
reload plugin has been removed from the default plugins list. Please use
Starting from version v2023.1.0, the OpenTelemetry (OTEL) middleware configuration has been moved out of the HTTP plugin to support its usage across multiple plugins, including HTTP, gRPC, jobs and temporal. The OTEL middleware is now configured using a top-level YAML key.
# HTTP plugin settings. http: ... middleware: [ "otel" ] otel: insecure: true compress: false client: http exporter: otlp custom_url: "" service_name: "rr_test" service_version: "1.0.0" endpoint: "127.0.0.1:4318"
http: ... middleware: [ "otel" ] otel: insecure: true compress: false client: http exporter: otlp custom_url: "" service_name: "rr_test" service_version: "1.0.0" endpoint: "127.0.0.1:4318"
To update your configuration from version 2.7 to version 3, follow these steps:
otelmiddleware configuration: If your configuration uses the
otelmiddleware configuration within the
httpplugin, move it to the configuration root by cutting it from the
httpplugin and pasting it at the root level.
reloadplugin configuration and if needed, use the
.rr.yamlused as the configuration, located in the same directory with RR binary.