fkde / aspx
Transform your existing PHP application into a deployable docker container in seconds.
Requires
- php: >7.4
Requires (Dev)
- phpspec/prophecy: ^1.20
- phpspec/prophecy-phpunit: ^2.3
- phpunit/phpunit: ^11.4
README
Transform your existing PHP Application into a deployable docker container based on Alpine Linux.
What you'll get
- PHP 8.3
- Nginx 1.26.2
- Curl
PHP Modules
- php83-fpm
- php83-json
- php83-ldap
- php83-curl
- php83-phar
- php83-pdo
- php83-iconv
- php83-mbstring
- php83-pdo_mysql
- php83-simplexml
- php83-dom
- php83-ctype
- php83-tokenizer
- php83-xml
- php83-xmlwriter
- php83-session
- php83-pecl-xdebug
Everything together is just as big as ~92.4Mb, which makes it ideal for fast and storage friendly CI/CD Pipelines. With npm and Node.js installed it is barely reaching ~150Mb.
Requirements
- Linux (Windows is coming soon, WSL is working fine)
- PHP (maybe removed as a requirement in the future)
- Docker
- Make
Installation
Composer
$> composer require fkde/aspx --dev
From your application root, call the following command:
$> ./vendor/bin/aspx install
After a few seconds you should be informed about the container being started. You should now be able to call https://localhost in your favorite browser.
When the installation finished you will notice a few changes in your project. There should be several new files and a folder added.
Added files
| Entity | Description |
|---|---|
| docker/: | This folder contains your container definition. You can change anything you want and just run make install again afterward. |
| docker-compose.yml | This file contains the service definitions for docker. |
| .env: | Is created only when there is no .env present. |
| Makefile: | This file provides a set of useful helpers, like a switch for Xdebug. Fore more information, take a look at the origin of this project: https://github.com/fkde/aspx |
You are now theoretically able to develop your application within Docker. Practically, you'll probably need a database to store your visitors' data.
Attaching a Database
We can utilize the docker-compose.yml to get a database attached.
Just uncomment the additional service and provide your credentials in the .env file.
If you had your own .env file before, just add the required variables to it.
Usage
Connect to the container
$> make ssh
Activate Xdebug
$> make xdebug-on
Deactivate with:
$> make xdebug-off
How does this all work?
Mount
Your application is being mounted into the container and is then held in sync by Docker. Inside
the container the path is /var/www, which is also the directory Nginx is pointing to.
Permissions
While building the container, a user is being created inside which is getting the same uid as your user. This means, everything being created by the container is handled as if it was you. That will reduce errors regarding different user permissions to nearly zero.
FAQ
Why do I need PHP on my Host Machine installed?
As this is a Composer package, and Composer itself depends on PHP this is something which is not that easy to achieve. However, it is planned to remove this dependency in the future by using another docker container with only php and composer to get the initial setup done.
Is it possible to run Laravel with this setup?
Yes of course, Laravel works like a charm with this setup. Just keep in mind that you need to have npm and NodeJS somewhere installed. It is possible to do that in the container though. It also decreases the resulting image size significantly (~124Mb instead of ~1.66Gb)
What does ASPX mean?
ASPX is nearly an acronym and stands for Alpine Supervisor PHP NginX.