RoadRunner
  • ๐ŸŸ General
    • What is RoadRunner?
    • Features
    • Quick Start
    • Installation
    • Configuration
    • Contributing
    • Upgrade and Compatibility
  • ๐Ÿ‘ทPHP Worker
    • Worker
    • Workers pool
    • Developer mode
    • Code Coverage
    • Debugging
    • Environment
    • Manual workers scaling
    • Auto workers scaling
    • RPC
  • ๐ŸŸขCustomization
    • Building RR with a custom plugin
    • Integrating with Golang Apps
    • Writing a Middleware
    • Writing a Jobs Driver
    • Writing a Plugin
    • Events Bus
  • ๐Ÿ”ŒPlugins
    • Intro into Plugins
    • Centrifuge (WebSockets)
    • Service (Systemd)
    • Configuration
    • Server
    • Locks
    • gRPC
    • TCP
  • ๐ŸŒCommunity Plugins
    • Intro into Community Plugins
    • Circuit Breaker
    • SendRemoteFile
    • RFC 7234 Cache
  • ๐Ÿ”ตApp Server
    • Production Usage
    • RoadRunner with NGINX
    • RR as AWS Lambda
    • Docker Images
    • CLI Commands
    • Systemd
  • ๐Ÿ”Key-Value
    • Intro into KV
    • Memcached
    • In-Memory
    • BoltDB
    • Redis
  • ๐Ÿ“ฆQueues and Jobs
    • Intro into Jobs
    • Google Pub/Sub
    • Beanstalk
    • In-Memory
    • RabbitMQ
    • BoltDB
    • Kafka
    • NATS
    • SQS
  • ๐Ÿ•ธ๏ธHTTP
    • Intro into HTTP
    • Headers and CORS
    • Proxy IP parser
    • Static files
    • X-Sendfile
    • Streaming
    • gzip
  • ๐Ÿ“ˆLogging and Observability
    • OpenTelemetry
    • HealthChecks
    • Access Logs
    • AppLogger
    • Metrics
    • Grafana
    • Logger
  • ๐Ÿ”€Workflow Engine
    • Temporal.io
    • Worker
  • ๐ŸงฉIntegrations
    • Migration from RRv1 to RRv2
    • Spiral Framework
    • Yii
    • Symfony
    • Laravel
    • ChubbyPHP
  • ๐ŸงชExperimental Features
    • List of the Experimental Features
  • ๐ŸšจError codes
    • CRC validation failed
    • Allocate Timeout
  • ๐Ÿ“šReleases
    • v2025.1.1
    • v2025.1.0
    • v2024.3.5
    • v2024.3.4
    • v2024.3.3
    • v2024.3.2
    • v2024.3.1
    • v2024.3.0
Powered by GitBook
On this page
  • Configuration File Structure
  • Tips

Was this helpful?

Edit on GitHub
  1. Plugins

Configuration

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.

Configuration File Structure

The RoadRunner configuration file should be formatted using YAML or JSON. Each configuration file must include a 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:

.rr.yaml
version: '3'

# ... other config values

Version numbers are strings, not numbers. For example, version: "3" is correct, but version: 3 is not.

Tips

  1. By default, .rr.yaml used as the configuration, located in the same directory with RR binary.

PreviousService (Systemd)NextServer

Last updated 1 year ago

Was this helpful?

๐Ÿ”Œ