roadrunner
π€― High-performance PHP application server, process manager written in Go and powered with plugins
File Explorer
Download Latest Version (.zip)- settings.json
- pre-commit
- bug-report.yml
- chore.yml
- config.yml
- feature-request.yml
- codeql-analysis.yml
- dependency-review.yml
- e2e.yml
- release.yml
- release_dep.yml
- release_dep_aarch64.yml
- release_grpc.yml
- semgrep.yml
- tests.yml
- CODEOWNERS
- dependabot.yml
- FUNDING.yml
- pull_request_template.md
- launch.json
- simple.js
- command_test.go
- doc.go
- main.go
- endure_ok.yaml
- endure_ok_debug.yaml
- endure_ok_error.yaml
- endure_ok_foobar.yaml
- endure_ok_info.yaml
- endure_ok_warn.yaml
- without_endure_ok.yaml
- config.go
- config_test.go
- container_test.go
- doc.go
- plugins.go
- command.go
- command_test.go
- doc.go
- render.go
- subcommands.go
- command.go
- command_test.go
- doc.go
- command.go
- command_test.go
- command_windows.go
- doc.go
- command.go
- command_test.go
- doc.go
- command.go
- command_test.go
- doc.go
- render.go
- doc.go
- root.go
- root_test.go
- doc.go
- server.go
- server_test.go
- doc.go
- meta.go
- meta_test.go
- .rr-include.yaml
- .rr.yaml
- config_rpc_conn_err.yaml
- config_rpc_empty.yaml
- config_rpc_ok.yaml
- config_rpc_ok_env.yaml
- config_rpc_wrong.yaml
- client.go
- client_test.go
- doc.go
- includes.go
- doc.go
- sdnotify.go
- doc.go
- roadrunner.go
- roadrunner_test.go
- 1.0.schema.json
- 2.0.schema.json
- 3.0.schema.json
- package-lock.json
- package.json
- readme.md
- test.js
- .rr-grpc-otel.yaml
- .rr-grpc.yaml
- .rr-http-middleware.yaml
- .rr-http-otel.yaml
- .rr-http-static.yaml
- .rr-jobs-memory-otel.yaml
- .rr-jobs-memory.yaml
- doc.go
- helpers.go
- doc.go
- logger.go
- observer.go
- Service.php
- ServingStatus.php
- HealthCheckRequest.php
- HealthCheckResponse.php
- HealthInterface.php
- EchoInterface.php
- Message.php
- EchoService.php
- HealthService.php
- worker-grpc.php
- client.php
- echo.php
- jobs_ok.php
- .gitignore
- composer.json
- service.pb.go
- service.proto
- service_grpc.pb.go
- sample.txt
- doc.go
- e2e_grpc_test.go
- e2e_http_test.go
- e2e_jobs_test.go
- go.mod
- go.sum
- .dockerignore
- .editorconfig
- .gitignore
- .golangci.yml
- .rr.yaml
- CHANGELOG.md
- CLAUDE.md
- CODE_OF_CONDUCT.md
- codecov.yml
- composer.json
- CONTRIBUTING.md
- Dockerfile
- download-latest.sh
- githooks-installer.sh
- go.mod
- go.sum
- go.work
- go.work.sum
- LICENSE
- Makefile
- README.md
- SECURITY.md
# Installation Guide
git clone https://github.com/roadrunner-server/roadrunner
Downloads the entire project code from GitHub to your computer.
cd roadrunner
Moves into the project folder you just downloaded.
2. Official Install Script
Easy Recommended- Homebrew A package manager for macOS/Linux.
- Chocolatey A package manager for Windows.
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/roadrunner-server/roadrunner/master/download-latest.sh | sh
Downloads and runs the official install script in one line β this handles the full setup automatically.
brew install roadrunner
Installs the pre-built package via Homebrew β no source build required.
choco install roadrunner
Installs directly via Chocolatey (Windows).
Pulled directly from this repo's README.
3. Docker
Easy- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t roadrunner .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 roadrunner
Runs the built image as an actual container.
4. Node.js
Easycd schemas
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
5. PHP (Composer)
Easycomposer require spiral/roadrunner-cli
Type this command into your terminal and run it.
Pulled directly from this repo's README.
6. Go
Mediumgo build ./...
Compiles the Go program into an executable.
go run .
Runs the Go program directly without a separate build step.
7. Make
Medium- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.