radiergummi/roadrunner-symfony-skeleton

v1.0.0 2020-02-15 11:32 UTC

Requires

• php: ^7.2.5
• ext-ctype: *
• ext-iconv: *
• baldinof/roadrunner-bundle: ^1.0
• symfony/console: 5.0.*
• symfony/dotenv: 5.0.*
• symfony/flex: ^1.3.1
• symfony/framework-bundle: 5.0.*
• symfony/yaml: 5.0.*

Conflicts

• symfony/symfony: *

Replaces

• paragonie/random_compat: 2.*
• symfony/polyfill-ctype: *
• symfony/polyfill-iconv: *
• symfony/polyfill-php56: *
• symfony/polyfill-php70: *
• symfony/polyfill-php71: *
• symfony/polyfill-php72: *

MIT

README

A bare-bones skeleton project, prepared to run Symfony 5, served by Roadrunner, in a Docker image.

Features

The image includes only what's actually required to wire things up. It provides:

• Pre-configured Symfony integration using baldinof/symfony-roadrunner-bundle
• Automatic worker reloading after each request, so you can live-edit in development
• Easy configuration: All config files in the project root
• Working docker-compose development environment, project is mounted into the image
• Working Sessions

Installation

via Composer:

composer create-project --prefer-dist radiergummi/roadrunner-symfony-skeleton your_app

via Git:

git clone https://github.com/Radiergummi/roadrunner-symfony-skeleton.git your_app
cd your_app

# install dependencies
composer install

# init config
composer init-config

Usage

Start the container:

docker-compose up

...then open localhost:8080, and you're ready to go.

Configuration

The project exposes multiple configuration files:

• .rr.yaml: The Roadrunner configuration file. It only includes the directives required for the project setup to work properly. You can find the reference at roadrunner.dev/docs/intro-config.
• php.ini: The main PHP configuration file. By default, it only includes the configuration recommended by Symfony, but you can change this file however you want.
• Dockerfile: The Dockerfile is split into a builder image that downloads the roadrunner binary and the actual image (that's called a multi-stage build). If you need to make changes, you'll want to add them to the bottom image.
• docker-compose.yaml: The docker-compose configuration file. By default, it's configured to serve a development stack, with the project directory being mounted into the image working directory, essentially overriding the built files. This allows you to live-edit the files within the container while it runs. It also exposes the metrics and health services to the outside world on their default ports.
  Lastly, it overrides the default entry point to add the debug and verbose flags and restart the worker after every request.
• config/packages/baldinof_road_runner.yaml: The configuration file for the bridge bundle. You can find a reference at github.com/baldinof/roadrunner-bundle, but it works fine with the defaults.