Bootstrap your new Laravel projects with package dependency installation and a highly configurable production ready Docker environment.
Arc is a simple Laravel package to add the ultimate docker environment for the majority of your applications. Built upon the amazing ContinuousPipe Dockerfiles, this package will add the correct Dockerfile, Docker Compose and configurations into your Laravel project. Additionally, Arc will prompt you to install some package dependencies that are popular additions to any Laravel project.
The Docker configuration provides the following -
- PHP 7.2 (Configurable for 5.6, 7.0, 7.1 & 7.2)
- NodeJS 10 inc NPM
- NGINX
- MySQL 5.7
- REDIS 3
- ConfD templating
- SupervisorD for process management
- Configurable queue workers
- Auto start Laravel Horizon processes
- Auto start CRON
- Easily create a CRON only container. Useful for zero downtime deployments to a Kubernetes cluster
- Configure the entire infrastructure with environment variables.
This package is intended for new Laravel >5.5 projects.
composer require richdynamix/arc php artisan arc:installThe installer will ask if you would like to install the following packages. While some of these packages are not for every project they bring huge value to any project.
| Package | Description |
|---|---|
| barryvdh/laravel-ide-helper | This package generates a file that your IDE understands, so it can provide accurate autocompletion. Generation is done based on the files in your project, so they are always up-to-date. |
| ellipsesynergie/api-response | Simple package to handle response properly in your API. This package uses Fractal and is based on Build APIs You Won't Hate book. |
| genealabs/laravel-model-caching | A package that abstracts the caching process into the model and provides self-invalidating relationship (only eager-loading) caching, query caching and automatic use of cache tags for cache providers that support them (will flush entire cache for providers that don't) |
| lord/laroute | This package ports the routes over to JavaScript, and gives a bunch of very familiar helper functions to use. |
| laravel/horizon | Horizon provides a beautiful dashboard and code-driven configuration for your Laravel powered Redis queues. Horizon allows you to easily monitor key metrics of your queue system such as job throughput, runtime, and job failures. |
docker-compose upNote: Before running your Docker container, ensure you have already run your composer install on the host machine, otherwise you will need to pass in any GitHub personal access tokens or BitBucket SSH keys at built time to access the private repositories. See Configuration on how to do this.
As part of the Arc configurations there is a simple bash script added to the root of your project which allows you to call -
./sshThis is simply a wrapper script for convenience. Under the hood its simply calling docker exec -it arc_web_1 bash
Arc is nothing more than a way to automatically copy the correct Docker configuration into your Laravel project. While you may have come across several Laravel based Docker environments, none of them cover the production ready setup that the ContinuousPipe dockerfiles provide.
ContinuousPipe Dockerfile offer an extremely flexible and solid infrastructure setup using a simple system of ConfD for templates and SupervisorD for controlling the start of services. The contents of tools/docker/etc and tools/docker/usr are copied into the container at build time which means we can influence any environment variable and configuration.
Rather that explain all the functions and environent variables available to Arc, it is easier to point you to the documentation for the parent images.
- PHP NGINX - The direct parent of the Arc Docker file. By default it uses PHP 7.1 but you can change this within the Arc Dockerfile to match your needs. (Available versions are 5.6, 7.0 and 7.1)
- Ubuntu 16.04 - This is the base image which the PHP image extends. This setups all the ConfD and SupervisorD configuration.
To manipulate your environment you can add values for any of the environment variables for any of the above. Additionally there are a few specific for Arc which are all defined in tools/docker/usr/local/share/env/20-arc-env.
| Variable | Description | Expected values | Default |
|---|---|---|---|
| START_QUEUE | Should the Laravel Queue worker be started. | true/false | true |
| RUN_LARAVEL_CRON | Should the Laravel Queue worker be started. | true/false | false |
| START_HORIZON | Should Laravel Horizon worker be started. Do not start START_QUEUE & START_HORIZON at the same time. | true/false | false |
Please Note: START_QUEUE & START_HORIZON are automatically configured if you install laravel/horizon during installation.
- Add additional packages that are frequently used
- Easier configuration of packages that require some manual setup
This package would not have been possible would it not have been for the amazing work of the ContinuousPipe team. But a special thanks to Samuel for the introduction of ContinuousPipe and Kubernetes. His ability to teach Docker concepts has been of huge value. A huge thanks to Kieren for his attention to detail and everlasting patience when helping me understand the ContinuousPipe Dockerfiles and setup.
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.