Compare commits

...

7 Commits

Author SHA1 Message Date
65b6dd8d73 Create FUNDING.yml 2025-07-19 02:28:00 +02:00
48abada5d7 Update tests (#86)
Some checks failed
Tests / integration (push) Has been cancelled
Build / docker (push) Has been cancelled
* Optimization of entrypoint

* Add version file

* Update tests
2025-05-11 09:45:53 +02:00
86b7f969d3 Optimization of entrypoint (#85)
* Optimization of entrypoint

* Add version file
2025-05-11 09:17:02 +02:00
619f66f44e Merge pull request #84 from jkaninda/develop
Some checks failed
Build / docker (push) Failing after 36s
Tests / integration (push) Failing after 2s
Update core features
2024-12-27 19:21:23 +01:00
f244eb704c Update core features
Some checks failed
Tests / integration (push) Failing after 3s
2024-12-27 19:20:49 +01:00
8731e698bc Merge pull request #83 from jkaninda/develop
Some checks failed
Build / docker (push) Failing after 1m17s
Tests / integration (push) Failing after 5s
ci: update manual build
2024-12-13 19:55:18 +01:00
b90f1c3c32 ci: update manual build
Some checks failed
Tests / integration (push) Failing after 8s
2024-12-13 19:53:56 +01:00
8 changed files with 347 additions and 272 deletions

1
.github/FUNDING.yml vendored Normal file
View File

@@ -0,0 +1 @@
ko_fi: jkaninda

View File

@@ -7,8 +7,6 @@ on:
required: true
default: 'latest'
type: string
env:
BUILDKIT_IMAGE: jkaninda/laravel-php-fpm
jobs:
docker:
runs-on: ubuntu-latest
@@ -31,78 +29,110 @@ jobs:
with:
file: "./src/docker/7.2/Dockerfile"
push: true
tags: "${{env.BUILDKIT_IMAGE}}:7.2"
tags: "${{vars.BUILDKIT_IMAGE}}:7.2"
-
name: Build and push 7.3
uses: docker/build-push-action@v3
with:
file: "./src/docker/7.3/Dockerfile"
push: true
tags: "${{env.BUILDKIT_IMAGE}}:7.3"
tags: "${{vars.BUILDKIT_IMAGE}}:7.3"
-
name: Build and push 7.4
uses: docker/build-push-action@v3
with:
file: "./src/docker/7.4/Dockerfile"
push: true
tags: "${{env.BUILDKIT_IMAGE}}:7.4"
tags: "${{vars.BUILDKIT_IMAGE}}:7.4"
-
name: Build and push 8.0
uses: docker/build-push-action@v3
with:
file: "./src/docker/8.0/Dockerfile"
push: true
tags: "${{env.BUILDKIT_IMAGE}}:8.0"
tags: "${{vars.BUILDKIT_IMAGE}}:8.0"
-
name: Build and push 8.1
uses: docker/build-push-action@v3
with:
file: "./src/docker/8.1/Dockerfile"
file: "./src/docker/Dockerfile"
push: true
platforms: linux/amd64,linux/arm64
tags: "${{env.BUILDKIT_IMAGE}}:8.1"
-
name: Build and push 8.2
uses: docker/build-push-action@v3
with:
file: "./src/docker/8.2/Dockerfile"
push: true
platforms: linux/amd64,linux/arm64
tags: "${{env.BUILDKIT_IMAGE}}:8.2"
build-args: |
phpVersion=8.1
tags: "${{ vars.BUILDKIT_IMAGE }}:8.1"
-
name: Build and push 8.1 alpine
uses: docker/build-push-action@v3
with:
file: "./src/docker/8.1/Dockerfile.alpine"
file: "./src/docker/Dockerfile.alpine"
push: true
platforms: linux/amd64,linux/arm64
tags: |
"${{env.BUILDKIT_IMAGE}}:8.1-alpine"
build-args: |
phpVersion=8.1
tags: "${{ vars.BUILDKIT_IMAGE }}:8.1-alpine"
-
name: Build and push 8.2
uses: docker/build-push-action@v3
with:
file: "./src/docker/Dockerfile"
push: true
platforms: linux/amd64,linux/arm64
build-args: |
phpVersion=8.2
tags: "${{vars.BUILDKIT_IMAGE}}:8.2"
-
name: Build and push 8.2 alpine
uses: docker/build-push-action@v3
with:
file: "./src/docker/8.2/Dockerfile.alpine"
file: "./src/docker/Dockerfile.alpine"
push: true
platforms: linux/amd64,linux/arm64
tags: |
"${{env.BUILDKIT_IMAGE}}:8.2-alpine"
-
name: Build and push 8.3 alpine
uses: docker/build-push-action@v3
with:
file: "./src/docker/8.3/Dockerfile.alpine"
push: true
platforms: linux/amd64,linux/arm64
tags: |
"${{env.BUILDKIT_IMAGE}}:8.3-alpine"
build-args: |
phpVersion=8.2
tags: "${{vars.BUILDKIT_IMAGE}}:8.2-alpine"
-
name: Build and push 8.3
uses: docker/build-push-action@v3
with:
file: "./src/docker/8.3/Dockerfile"
file: "./src/docker/Dockerfile"
push: true
platforms: linux/amd64,linux/arm64
build-args: |
phpVersion=8.3
tags: |
"${{env.BUILDKIT_IMAGE}}:8.3"
"${{env.BUILDKIT_IMAGE}}:latest"
"${{vars.BUILDKIT_IMAGE}}:8.3"
-
name: Build and push 8.3 alpine
uses: docker/build-push-action@v3
with:
file: "./src/docker/Dockerfile.alpine"
push: true
platforms: linux/amd64,linux/arm64
build-args: |
phpVersion=8.3
tags: |
"${{vars.BUILDKIT_IMAGE}}:8.3-alpine"
-
name: Build and push 8.4 alpine
uses: docker/build-push-action@v3
with:
file: "./src/docker/Dockerfile.alpine"
push: true
platforms: linux/amd64,linux/arm64
build-args: |
phpVersion=8.4
tags: |
"${{vars.BUILDKIT_IMAGE}}:8.4-alpine"
-
name: Build and push 8.4
uses: docker/build-push-action@v3
with:
file: "./src/docker/Dockerfile"
push: true
platforms: linux/amd64,linux/arm64
build-args: |
phpVersion=8.4
tags: |
"${{vars.BUILDKIT_IMAGE}}:8.4"
"${{vars.BUILDKIT_IMAGE}}:latest"

View File

@@ -6,6 +6,12 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Build Docker Image
run: |
docker buildx build -f src/docker/Dockerfile --build-arg phpVersion=8.4 -t ${{ vars.BUILDKIT_IMAGE }}:latest --load .
- name: Verify Docker images
run: |
docker images
- name: Create Laravel project
run: |
composer create-project laravel/laravel laravel

368
README.md
View File

@@ -1,3 +1,8 @@
### 🐳 **Docker Image: Laravel PHP-FPM**
A **ready-to-use container** designed for running PHP-based applications, including Laravel microservices.
This Docker image comes with **PHP-FPM**, offering a robust foundation for your projects with built-in support for essential extensions and configurations.
[![Build](https://github.com/jkaninda/laravel-php-fpm/actions/workflows/build.yml/badge.svg)](https://github.com/jkaninda/laravel-php-fpm/actions/workflows/build.yml)
[![Tests](https://github.com/jkaninda/laravel-php-fpm/actions/workflows/tests.yml/badge.svg)](https://github.com/jkaninda/laravel-php-fpm/actions/workflows/tests.yml)
![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/jkaninda/laravel-php-fpm?style=flat-square)
@@ -9,116 +14,76 @@
</a>
</p>
# Laravel PHP-FPM Docker image
#### **Features**
- **PHP Application Support**: Optimized to run Laravel or any PHP-based applications.
- **Integrated Extensions**:
- **Database**: MySQL and PostgreSQL.
- **Caching**: Redis and Memcached.
- **Messaging**: Kafka for event-driven architecture.
- **Task Scheduling**: Laravel Scheduler and Cron jobs support.
- **Custom Configuration**: Pre-configured with sensible defaults, allowing seamless customization.
- **Event Handling**: Support for advanced event-driven processes.
- **Optimized for Microservices**: Built with modern PHP microservices in mind.
> 🐳 Full Docker image for a PHP-FPM container created to run Laravel or any php based applications.
This image is ideal for developers looking for a streamlined, high-performance solution to deploy PHP applications with essential tools already integrated.
> PHP Microservices ready Docker container image.
## Links:
- [Docker Hub](https://hub.docker.com/r/jkaninda/laravel-php-fpm)
- [Github](https://github.com/jkaninda/laravel-php-fpm)
---
## **Supported PHP Versions**
- 8.4
- 8.3
- 8.2
- 8.1
- 8.0
- 7.4
- 7.2
## PHP Version:
- 8.4
- 8.3
- 8.2
- 8.1
- 8.0
- 7.4
- 7.2
## Specifications:
---
* Composer
* OpenSSL PHP Extension
* XML PHP Extension
* PDO PHP Extension
* PDO Mysql
* PDO Pgsql
* Rdkafka PHP Extension
* Redis PHP Extension
* Mbstring PHP Extension
* PCNTL PHP Extension
* ZIP PHP Extension
* GD PHP Extension
* BCMath PHP Extension
* Memcached
* Opcache
* Laravel Cron Job
* Laravel Schedule
* Laravel Envoy
* Supervisord
* Node
* NPM
## **Specifications**
## Simple docker-compose usage:
### **PHP Extensions**
- Composer
- OpenSSL
- XML
- PDO (MySQL and PostgreSQL)
- Rdkafka
- Redis
- Mbstring
- PCNTL
- ZIP
- GD
- BCMath
- Memcached
- Opcache
```yml
version: '3'
### **Additional Features**
- Laravel Cron Jobs
- Laravel Scheduler
- Supervisord
- Node.js and NPM
---
## **Getting Started**
### **Simple Docker-Compose Example**
```yaml
services:
php-fpm:
image: jkaninda/laravel-php-fpm:latest
container_name: php-fpm
restart: unless-stopped
user: www-data #Use www-data user for production usage
volumes:
#Project root
- ./src:/var/www/html
networks:
- default #if you're using networks between containers
```
## Docker:
### Run
```sh
docker compose up -d
```
### Create Laravel project
```sh
docker compose exec php-fpm composer create-project --prefer-dist laravel/laravel .
```
### Artisan generate key
```sh
docker compose exec php-fpm php artisan key:generate
```
### Storage link
```sh
docker compose exec php-fpm php artisan storage:link
```
### Fix permissions
```sh
docker compose exec php-fpm chmod -R 777 storage bootstrap/cache
```
### Laravel migration
```sh
docker compose exec php-fpm php artisan migrate
```
###
```sh
docker exec -it php-fpm bash
```
## Configurations
- Supervisor config folder: /etc/supervisor/conf.d/
- PHP ini config foler /usr/local/etc/php/conf.d/
## Example Laravel-php-fpm with nginx:
### docker-compose.yml
```yml
services:
php-fpm:
image: jkaninda/laravel-php-fpm
container_name: php-fpm
restart: unless-stopped
volumes:
#Project root
- ./:/var/www/html
networks:
- default #if you're using networks between containers
#Nginx server
nginx-server:
php-fpm:
image: jkaninda/laravel-php-fpm:latest
container_name: php-fpm
restart: unless-stopped
user: www-data # For production
volumes:
- ./:/var/www/html
networks:
- default
nginx-server:
image: jkaninda/nginx-fpm:alpine
container_name: nginx-server
restart: unless-stopped
@@ -132,64 +97,64 @@ services:
- PHP_FPM_HOST=php-fpm:9000
networks:
- default
```
## Simple Nginx config file content
### default.conf
```conf
server {
listen 80;
index index.php index.html;
error_log /var/log/nginx/error.log;
access_log /var/log/nginx/access.log;
##Public directory
root /var/www/html/public;
location ~ \.php$ {
try_files $uri =404;
fastcgi_split_path_info ^(.+\.php)(/.+)$;
## PHP FPM ( php-fpm:9000 ) or [servicename:9000]
fastcgi_pass php-fpm:9000;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
fastcgi_param PATH_INFO $fastcgi_path_info;
}
client_max_body_size 15M;
server_tokens off;
# Hide PHP headers
fastcgi_hide_header X-Powered-By;
fastcgi_hide_header X-CF-Powered-By;
fastcgi_hide_header X-Runtime;
location / {
try_files $uri $uri/ /index.php?$query_string;
gzip_static on;
}
}
```
## Advanced Laravel-php-fpm with nginx:
### docker-compose.yml
```yml
### **Basic Commands**
- **Start Containers**
```sh
docker compose up -d
```
- **Create a Laravel Project**
```sh
docker compose exec php-fpm composer create-project --prefer-dist laravel/laravel .
```
- **Generate Application Key**
```sh
docker compose exec php-fpm php artisan key:generate
```
- **Create Storage Symlink**
```sh
docker compose exec php-fpm php artisan storage:link
```
- **Fix Permissions**
```sh
docker compose exec php-fpm chmod -R 777 storage bootstrap/cache
```
- **Run Laravel Migrations**
```sh
docker compose exec php-fpm php artisan migrate
```
- **Access the Container Shell**
```sh
docker exec -it php-fpm bash
```
---
## **Advanced Usage with Nginx**
### **Docker-Compose with Nginx**
Example of using a custom nginx config:
```yaml
version: '3'
services:
php-fpm:
image: jkaninda/laravel-php-fpm
container_name: php-fpm
restart: unless-stopped
volumes:
#Project root
- ./:/var/www/html
- ~/.ssh:/root/.ssh # If you use private CVS
- ./php.ini:/usr/local/etc/php/conf.d/php.ini # Optional, your custom php init file
environment:
- APP_ENV=development # Optional, or production
#- LARAVEL_PROCS_NUMBER=1 # Optional, Laravel queue:work process number
#Nginx server
nginx-server:
php-fpm:
image: jkaninda/laravel-php-fpm
container_name: php-fpm
restart: unless-stopped
volumes:
- ./:/var/www/html
networks:
- default
nginx-server:
image: nginx:alpine
container_name: nginx-server
restart: unless-stopped
@@ -198,46 +163,68 @@ services:
volumes:
- ./:/var/www/html
- ./default.conf:/etc/nginx/conf.d/default.conf
environment:
- DOCUMENT_ROOT=/var/www/html/public
- CLIENT_MAX_BODY_SIZE=20M
- PHP_FPM_HOST=php-fpm:9000
networks:
- default
volumes:
storage-data:
```
## Docker run
```sh
docker compose up -d
### **Nginx Configuration (default.conf)**
```
## Build from base
```conf
server {
listen 80;
index index.php index.html;
root /var/www/html/public;
Dockerfile
location ~ \.php$ {
try_files $uri =404;
fastcgi_split_path_info ^(.+\.php)(/.+)$;
fastcgi_pass php-fpm:9000;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
fastcgi_param PATH_INFO $fastcgi_path_info;
}
location / {
try_files $uri $uri/ /index.php?$query_string;
gzip_static on;
}
client_max_body_size 15M;
server_tokens off;
fastcgi_hide_header X-Powered-By;
}
```
---
## **Custom Build**
### **Dockerfile Example**
```Dockerfile
FROM jkaninda/laravel-php-fpm:8.3
# Copy laravel project files
# Copy Laravel project files
COPY . /var/www/html
# Storage Volume
VOLUME /var/www/html/storage
WORKDIR /var/www/html
# Custom cache invalidation / optional
#ARG CACHEBUST=1
# Run composer install / Optional
#RUN composer install
# Fix permissions
RUN chown -R www-data:www-data /var/www/html
USER www-data
```
## Supervisord
### Add supervisor process in
> /etc/supervisor/conf.d/
---
In case you want to execute and maintain a task or process with supervisor.
## **Supervisord Integration**
Find below an example with Apache Kafka, when you want to maintain a consumer process.
### Example:
### **Adding Custom Supervisor Processes**
Place configurations in `/etc/supervisor/conf.d/`.
Example Kafka consumer process:
```conf
[program:kafkaconsume-worker]
process_name=%(program_name)s_%(process_num)02d
@@ -250,21 +237,26 @@ redirect_stderr=true
stdout_logfile=/var/www/html/storage/logs/kafka.log
```
### Custom php.ini
> /var/www/html/conf/php/php.ini
---
### Storage permision issue
```sh
docker compose exec php-fpm /bin/bash
```
## **Custom PHP Configurations**
Place your custom `php.ini` file at:
```
/usr/local/etc/php/conf.d/
```
---
## **Storage Permissions Fix**
If you encounter permission issues, run:
```sh
chown -R www-data:www-data /var/www/html
```
> chmod -R 775 /var/www/html/storage
> P.S. please give a star if you like it :wink:
docker compose exec php-fpm /bin/bash
chown -R www-data:www-data /var/www/html
chmod -R 775 /var/www/html/storage
```
---
### ⭐️ **Support the Project**
If you find this project useful, please give it a ⭐️ on GitHub! 😊

29
compose.yaml Normal file
View File

@@ -0,0 +1,29 @@
services:
php-fpm:
image: jkaninda/laravel-php-fpm
container_name: php-fpm
restart: unless-stopped
user: www-data #Use www-data user production usage
volumes:
#Project root
- ./:/var/www/html
networks:
- web #if you're using networks between containers
#Nginx server
nginx-server:
image: jkaninda/nginx-fpm:alpine
container_name: nginx-server
restart: unless-stopped
ports:
- 80:80
volumes:
- ./:/var/www/html
environment:
- DOCUMENT_ROOT=/var/www/html/public
- CLIENT_MAX_BODY_SIZE=20M
- PHP_FPM_HOST=php-fpm:9000
networks:
- web
networks:
web:
external: false

View File

@@ -1,63 +1,79 @@
#!/bin/bash
set -e
# Logging functions
log() {
local level=$1
shift
{ set +x; } 2> /dev/null
echo "[$level] $@"
}
info() {
log "INFO" "$@"
}
warning() {
log "WARNING" "$@"
}
fatal() {
log "ERROR" "$@" >&2
exit 1
}
# Banner
echo ""
echo "***********************************************************"
echo " Starting LARAVEL PHP-FPM Container "
echo "***********************************************************"
set -e
info() {
{ set +x; } 2> /dev/null
echo '[INFO] ' "$@"
}
warning() {
{ set +x; } 2> /dev/null
echo '[WARNING] ' "$@"
}
fatal() {
{ set +x; } 2> /dev/null
echo '[ERROR] ' "$@" >&2
exit 1
}
## Check if the artisan file exists
if [ -f /var/www/html/artisan ]; then
info "Artisan file found, creating laravel supervisor config..."
##Create Laravel Scheduler process
TASK=/etc/supervisor/conf.d/laravel-worker.conf
touch $TASK
cat > "$TASK" <<EOF
[program:Laravel-scheduler]
process_name=%(program_name)s_%(process_num)02d
command=/bin/sh -c "while [ true ]; do (php /var/www/html/artisan schedule:run --verbose --no-interaction &); sleep 60; done"
autostart=true
autorestart=true
numprocs=1
user=$USER_NAME
stdout_logfile=/var/log/laravel_scheduler.out.log
redirect_stderr=true
[program:Laravel-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /var/www/html/artisan queue:work --sleep=3 --tries=3
autostart=true
autorestart=true
numprocs=$LARAVEL_PROCS_NUMBER
user=$USER_NAME
redirect_stderr=true
stdout_logfile=/var/log/laravel_worker.log
# Check if the artisan file exists
ARTISAN_PATH="/var/www/html/artisan"
if [[ -f "$ARTISAN_PATH" ]]; then
info "Artisan file found, creating Laravel supervisor config..."
# Create Laravel Supervisor config
SUPERVISOR_TASK="/etc/supervisor/conf.d/laravel-worker.conf"
cat > "$SUPERVISOR_TASK" <<EOF
[program:Laravel-scheduler]
process_name=%(program_name)s_%(process_num)02d
command=/bin/sh -c "while true; do php $ARTISAN_PATH schedule:run --verbose --no-interaction & sleep 60; done"
autostart=true
autorestart=true
numprocs=1
user=$USER_NAME
stdout_logfile=/var/log/laravel_scheduler.out.log
redirect_stderr=true
[program:Laravel-worker]
process_name=%(program_name)s_%(process_num)02d
command=php $ARTISAN_PATH queue:work --sleep=3 --tries=3
autostart=true
autorestart=true
numprocs=$LARAVEL_PROCS_NUMBER
user=$USER_NAME
redirect_stderr=true
stdout_logfile=/var/log/laravel_worker.log
EOF
info "Laravel supervisor config created"
info "Laravel supervisor config created at $SUPERVISOR_TASK"
else
info "artisan file not found"
info "Artisan file not found at $ARTISAN_PATH"
fi
## Check if php.ini file exists
if [ -f /var/www/html/conf/php/php.ini ]; then
cp /var/www/html/conf/php/php.ini $PHP_INI_DIR/conf.d/
info "Custom php.ini file found and copied in $PHP_INI_DIR/conf.d/"
# Check if custom php.ini file exists
PHP_INI_SOURCE="/var/www/html/conf/php/php.ini"
PHP_INI_TARGET="$PHP_INI_DIR/conf.d/php.ini"
if [[ -f "$PHP_INI_SOURCE" ]]; then
cp "$PHP_INI_SOURCE" "$PHP_INI_TARGET"
info "Custom php.ini file found and copied to $PHP_INI_TARGET"
else
info "Custom php.ini file not found"
info "If you want to add a custom php.ini file, you add it in /var/www/html/conf/php/php.ini"
info "Custom php.ini file not found at $PHP_INI_SOURCE"
info "To use a custom php.ini file, place it at $PHP_INI_SOURCE"
fi
supervisord -c /etc/supervisor/supervisord.conf
# Start Supervisor
supervisord -c /etc/supervisor/supervisord.conf

View File

@@ -12,7 +12,7 @@ services:
ports:
- 3306:3306
php-fpm:
image: jkaninda/laravel-php-fpm
image: jkaninda/laravel-php-fpm:latest
container_name: php-fpm
restart: unless-stopped
#user: www-data #Use www-data user production usage

1
version Normal file
View File

@@ -0,0 +1 @@
8.4.7