The objective of this repository is having a CaaS Containers as a Service to provide a start up application with the basic enviroment features to deploy a php service running with Nginx and PHP-FPM in a container for Laravel and another container with a MySQL database to follow the best practices on an easy scenario to understand and modify on development requirements.
The connection between container is as Host Network on eth0, thus both containers do not share networking or bridge configuration.
As client end user both services can be accessed through localhost:${PORT} but the connection between containers is through the ${HOSTNAME}:${PORT}.
- Built on the lightweight and secure Alpine 3.19 2024 release Linux distribution
- Multi-platform, supporting AMD4, ARMv6, ARMv7, ARM64
- Very small Docker image size (+/-40MB)
- Uses PHP 8.3 as default for the best performance, low CPU usage & memory footprint, but also can be downgraded till PHP 8.0
- Optimized for 100 concurrent users
- Optimized to only use resources when there's traffic (by using PHP-FPM's
on-demandprocess manager) - The services Nginx, PHP-FPM and supervisord run under a project-privileged user to make it more secure
- The logs of all the services are redirected to the output of the Docker container (visible with
docker logs -f <container name>) - Follows the KISS principle (Keep It Simple, Stupid) to make it easy to understand and adjust the image to your needs
- Services independency to connect the application to other database allocation
To use a different PHP 8 version the following Dockerfile arguments and variable must be modified:
ARG PHP_VERSION=8.3
ARG PHP_ALPINE=83
...
ENV PHP_V="php83"And must be inform to Supervisor Config the FPM version to run.
...
[program:php-fpm]
command=php-fpm83 -F
...This project has not been tested on Windows OS neither I can use it to test it. So, I cannot bring much support on it.
Anyway, using this repository you will needed to find out your PC IP by login as an administrator user to set connection between containers.
C:\WINDOWS\system32>ipconfig /all
Windows IP Configuration
Host Name . . . . . . . . . . . . : 191.128.1.41
Primary Dns Suffix. . . . . . . . : paul.ad.cmu.edu
Node Type . . . . . . . . . . . . : Peer-Peer
IP Routing Enabled. . . . . . . . : No
WINS Proxy Enabled. . . . . . . . : No
DNS Suffix Search List. . . . . . : scs.ad.cs.cmu.eduTake the first ip listed. Wordpress container will connect with database container using that IP.
Find out your IP on UNIX systems and take the first IP listed
$ hostname -I
191.128.1.41 172.17.0.1 172.20.0.1 172.21.0.1Directories and main files on a tree architecture description
.
│
├── docker
│ ├── mariadb
│ │ ├── ...
│ │ ├── .env.example
│ │ └── docker-compose.yml
│ │
│ └── nginx-php
│ ├── ...
│ ├── .env.example
│ └── docker-compose.yml
│
├── resources
│ ├── database
│ │ ├── laravel-init.sql
│ │ └── laravel-backup.sql
│ │
│ └── laravel
│ └── (any file or directory required for re-building the app...)
│
├── laravel
│ └── (application...)
│
├── .env
├── .env.example
└── Makefile
Makefiles are often used to automate the process of building and compiling software on Unix-based systems as Linux and macOS.
On Windows - I recommend to use Makefile:
https://stackoverflow.com/questions/2532234/how-to-run-a-makefile-in-windows
Makefile recipies
$ make help
usage: make [target]
targets:
Makefile help shows this Makefile help message
Makefile hostname shows local machine ip
Makefile fix-permission sets project directory permission
Makefile ports-check shows this project ports availability on local machine
Makefile laravel-ssh enters the Laravel container shell
Makefile laravel-set sets the Laravel PHP enviroment file to build the container
Makefile laravel-build builds the Laravel PHP container from Docker image
Makefile laravel-start starts up the Laravel PHP container running
Makefile laravel-stop stops the Laravel PHP container but data will not be destroyed
Makefile laravel-destroy stops and removes the Laravel PHP container from Docker network destroying its data
Makefile database-ssh enters the database container shell
Makefile database-set sets the database enviroment file to build the container
Makefile database-build builds the database container from Docker image
Makefile database-start starts up the database container running
Makefile database-stop stops the database container but data will not be destroyed
Makefile database-destroy stops and removes the database container from Docker network destroying its data
Makefile database-replace replace the build empty database copying the .sql backfile file into the container raplacing the pre-defined database
Makefile database-backup creates a copy as .sql file from container to a determined local host directory
Makefile project-set sets both Laravel and database .env files used by docker-compose.yml
Makefile project-build builds both Laravel and database containers from their Docker images
Makefile project-start starts up both Laravel and database containers running
Makefile project-stop stops both Laravel and database containers but data will not be destroyed
Makefile project-destroy stops and removes both Laravel and database containers from Docker network destroying their data
Makefile repo-flush clears local git repository cache specially to update .gitignoreCheckout local machine ports availability
$ make ports-check
Checking configuration for Laravel container:
Laravel > port:8888 is free to use.
Checking configuration for Laravel DB container:
Laravel DB > port:8889 is free to use.Checkout local machine IP to set connection between containers using the following makefile recipe
$ make hostname
192.168.1.41Before running the project checkout database connection health using a database mysql client.
- MySQL Workbench
- DBeaver
- HeidiSQL
- Or whatever you like. This Docker project doesn't come with PhpMyAdmin to make it lighter.
$ make project-build
LARAVEL docker-compose.yml .env file has been set.
LARAVEL DB docker-compose.yml .env file has been set.
[+] Building 9.1s (10/10) FINISHED docker:default
=> [mariadb internal] load build definition from Dockerfile 0.0s
=> => transferring dockerfile: 1.13kB
...
=> => naming to docker.io/library/lara-db:mariadb-15 0.0s
[+] Running 1/2
⠧ Network lara-db_default Created 0.7s
✔ Container lara-db Started 0.6s
[+] Building 49.7s (25/25) docker:default
=> [wordpress internal] load build definition from Dockerfile 0.0s
=> => transferring dockerfile: 2.47kB
...
=> => naming to docker.io/library/lara-app:php-8.3 0.0s
[+] Running 1/2
⠇ Network lara-app_default Created 0.8s
✔ Container lara-app Started$ make project-start
[+] Running 1/0
✔ Container lara-db Running 0.0s
[+] Running 1/0
✔ Container lara-app Running 0.0sNow, Laravel should be available on local machine by visiting http://localhost:8888/
Every time the containers are built or up and running it will be like start from a fresh installation.
So, you can follow the Wordpress Wizard steps to configure the project at requirements (language, ip and port, etc) with fresh database tables.
On he other hand, you can continue using this repository with the pre-set database executing the command $ make database-install
Follow the next recommendations to keep development stages clear and safe.
On first installation once Laravel app is running with an admin back-office user set, I suggest to make a initialization database backup manually, saving as resources/database/laravel-backup.sql but renaming as resources/database/laravel-init.sql to have that init database for any Docker compose rebuild / restart on next time.
The following three commands are very useful for Continue Development.
When the project is already in an advanced development stage, making a backup is recommended to avoid start again from installation step by keeping lastest database registers.
$ make database-backup
LARAVEL database backup has been created.If it is needed to restart the project from base installation step, you can use the init database .sql file to restart at that point in time. Though is not common to use, helps to check and test installation health.
$ make database-install
LARAVEL database has been installed.This repository comes with an initialized .sql with a main database user. See .env.example
Replace the database set on container with the latest .sql backup into current development stage.
$ make database-replace
LARAVEL database has been replaced.-
Notice that both files in resources/database/ have the database name that has been set on the main
.envfile to automate processes. -
Remember that on any change in the main
.envfile will be necessary to execute the following Makefile recipe
$ make project-set
LARAVEL docker-compose.yml .env file has been set.
LARAVEL DB docker-compose.yml .env file has been set.Docker container
$ sudo docker ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
ecd27aeae010 lara... "docker-php-entrypoi…" 3 mins... 9000/tcp, 0.0.0.0:8888->80/tcp, :::8888->80/tcp laravel-app
52a9994c31b0 lara... "/init" 4 mins... 0.0.0.0:8889->3306/tcp, :::8889->3306/tcp laravel-db
Docker image
$ sudo docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
laravel-app lara... 373f6967199b 5 minutes ago 200MB
laravel-db lara... 1f1775f7e1db 6 minutes ago 333MBDocker stats
$ sudo docker system df
TYPE TOTAL ACTIVE SIZE RECLAIMABLE
Images 1 1 532.2MB 0B (0%)
Containers 1 1 25.03kB 0B (0%)
Local Volumes 1 0 117.9MB 117.9MB (100%)
Build Cache 39 0 10.21kB 10.21kBVisiting http://localhost:8888/ should display Laravel's welcome page.
Use an API platform (Postman, Firefox RESTClient, etc..) to check connection with Laravel
GET: http://localhost:8888/api/v1/health
{
"status": true
}
Check connection to database through a test endpoint. If conenction params are not set already will response as follows
GET: http://localhost:8888/api/v1/health/db
{
"status": false,
"message": "Connect to database failed - Check connection params.",
"error": {
"errorInfo": [
"HY000",
2002,
"Host is unreachable"
]
}
}
Complete the MySQL database connection params. Use local hostname IP $ make hostname to set DB_HOST variable
DB_CONNECTION=mysql
DB_HOST=192.168.1.41
DB_PORT=8889
DB_DATABASE=laravel
DB_USERNAME=laravel
DB_PASSWORD=123456
Checking the connection to database once is set correctly will response as follows
GET: http://localhost:8888/api/v1/health/db
{
"status": true
}
Using the following Makefile recipe stops application and database containers, keeping database persistance and application files binded without any loss
$ make project-stop
[+] Killing 1/1
✔ Container laravel-db Killed 0.5s
Going to remove laravel-db
[+] Removing 1/0
✔ Container laravel-db Removed 0.0s
[+] Killing 1/1
✔ Container laravel-app Killed 0.5s
Going to remove laravel-app
[+] Removing 1/0
✔ Container laravel-app Removed 0.0sTo stop and remove both application and database containers from docker network use the following Makefile recipe
$ make project-destroy
[+] Killing 1/1
✔ Container laravel-db Killed 0.4s
Going to remove laravel-db
[+] Removing 1/0
✔ Container laravel-db Removed 0.0s
[+] Running 1/1
✔ Network laravel-db_default Removed 0.3s
[+] Killing 1/1
✔ Container laravel-app Killed 0.4s
Going to remove laravel-app
[+] Removing 1/0
✔ Container laravel-app Removed 0.0s
[+] Running 1/1
✔ Network laravel-app_default RemovedThe, remove the Docker images created for containers by its tag name reference
$ docker rmi $(docker images --filter=reference="*:laravel-*" -q)Prune Docker system cache
$ sudo docker system prune
...
Total reclaimed space: 423.4MBPrune Docker volume cache
$ sudo docker system prune
...
Total reclaimed space: 50.7MB