This repository contains an example of Laravel (PHP Framework) application that runs in a docker container with RoadRunner (high-performance PHP application server) as a web server.
- For local application running, you need just two dependencies - installed
dockeranddocker-compose(makeis optional, but strongly recommended) - PostgreSQL as a database and Redis as a cache & queue driver already configured
- One
Dockerfilefor local application development and running on production - All used images are based on Alpine (lightweight and security-oriented linux distributive)
- Lightweight final docker image (compressed size ~65 Mb, ~16 downloadable layers)
- Unprivileged user is used by default
- Easy to update PHP and dependencies
- Ready to run Laravel task scheduling, queue workers, and many others on your choice
- Without file permission problems
- For cron jobs running supercronic is used (crontab-compatible job runner, designed specifically to run in containers)
- Self-signed SSL certificate for HTTPS support
- Enabled
opcacheandjitcompiler for the performance of your application - Composer dependencies caching using separate docker image layer
- Well-documented code
- HTTP server doesn't need to be restarted on source code changes
- Works much faster than
php-fpm+nginxand easy to deploy - Provided
Makefileallows to perform familiar operations easy and fast - Ready to run phpunit (with code coverage) and phpstan (static analysis tool for source code)
- GitHub actions for tests running, image building, etc.
If you want to integrate Docker + RoadRunner into an existing application, take a look at pull requests with the special label in the current repository - you can repeat these steps.
Another way is repository cloning, forking or usage this repository as a template for your application.
Don't forget to remove
TestJob,TestController, and routes, that are declared for this controller in theroutes/web.phpfile - it is used for internal application working tests.
Let's dive deeper and watch how to start application development, based on this template. First, we need to get the sources:
$ git clone https://github.com/tarampampam/laravel-roadrunner-in-docker.git
$ cd ./laravel-roadrunner-in-dockerAfter that - build image with our application and install composer dependencies:
$ make install
...
- Installing spatie/laravel-ignition (2.0.0): Extracting archive
- Installing symfony/psr-http-message-bridge (v2.1.4): Extracting archive
- Installing spiral/goridge (v3.2.0): Extracting archive
- Installing spiral/roadrunner-worker (v2.3.0): Extracting archive
- Installing spiral/roadrunner-http (v2.2.0): Extracting archive
- Installing nyholm/psr7 (1.5.1): Extracting archive
- Installing spiral/roadrunner-laravel (v5.11.1): Extracting archive
Generating optimized autoload files
> Illuminate\Foundation\ComposerScripts::postAutoloadDump
> @php artisan package:discover --ansi
INFO Discovering packages.
laravel/sail ...................................................... DONE
laravel/sanctum ................................................... DONE
laravel/tinker .................................................... DONE
nesbot/carbon ..................................................... DONE
nunomaduro/collision .............................................. DONE
nunomaduro/termwind ............................................... DONE
spatie/laravel-ignition ........................................... DONE
spiral/roadrunner-laravel ......................................... DONEMake full application initialization:
$ make init
...
INFO Preparing database.
Creating migration table ..................................... 15ms DONE
INFO Running migrations.
2014_10_12_000000_create_users_table ......................... 27ms DONE
2014_10_12_100000_create_password_resets_table ............... 21ms DONE
2019_08_19_000000_create_failed_jobs_table ................... 17ms DONE
2019_12_14_000001_create_personal_access_tokens_table ........ 30ms DONE
INFO Seeding database.
...Start the application:
$ make up
...
Navigate your browser to ⇒ http://127.0.0.1:8080 or https://127.0.0.1:8443Voila! You can open http://127.0.0.1:8080 (or https://127.0.0.1:8443) in your browser and source code in your favorite IDE.
For watching all supported
makecommands executemakewithout parameters inside the project directory:$ make Available commands: help Show this help install Install all app dependencies shell Start shell into app container init Make full application initialization ...
Execute in your terminal:
$ make shellIn this shell, you can use composer, php, and any other tools, which are installed into a docker image.
$ docker-compose logs -fAll messages from all containers output will be listed here.
As it was told above - execute make shell and after that composer require %needed/package%.
Append into Makefile something like:
your-command: ## Your command help
/bin/your/app -goes -hereTab character in front of your command is mandatory!
Read more about makefiles here.
- Describe front-end development/building
This repo was created for Linux users. It maps /etc/passwd in docker-compose.yml to set the current host user for the Docker containers.
MacOS doesn't use /etc/passwd unless it's operating in single-user mode. Instead, it uses a system called Open Directory.
If you do make shell; whoami and get user errors, then you can fix by running ./scripts/fix_mac_user.sh. This script will create a mac_passwd file that plays nice with /etc/passwd used by docker-compose.yml under the volumes mapping section.
#!/bin/sh
// File: ./scripts/fix_mac_user.sh
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
cd $SCRIPT_DIR/../
echo "$USER:x:$(id -u):$(id -g):ns,,,:$HOME:/bin/bash" > mac_passwd
sed -i.backup 's~/etc/passwd:/etc/passwd:ro~./mac_passwd:/etc/passwd:ro~' docker-compose.yml
If you find any package errors, please, make an issue in current repository.
This project is open-sourced software licensed under the MIT license.