update readme

Create FUNDING.yml

.github/FUNDING.yml

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

.github/workflows/tests.yml

@@ -6,6 +6,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+          # Build the Docker image
+      - 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

README.md

@@ -1,164 +1,185 @@
+### 🐳 **Docker Image: Nginx PHP-FPM**  
+
+A **ready-to-use container** designed for running PHP-based applications, including Laravel microservices. This Docker image combines **Nginx** and **PHP-FPM**, offering a robust foundation for your projects with built-in support for essential extensions and configurations.  
+
 [![Build](https://github.com/jkaninda/nginx-php-fpm/actions/workflows/build.yml/badge.svg)](https://github.com/jkaninda/nginx-php-fpm/actions/workflows/build.yml)
 [![Tests](https://github.com/jkaninda/nginx-php-fpm/actions/workflows/tests.yml/badge.svg)](https://github.com/jkaninda/nginx-php-fpm/actions/workflows/tests.yml)
 ![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/jkaninda/nginx-php-fpm?style=flat-square)
 ![Docker Pulls](https://img.shields.io/docker/pulls/jkaninda/nginx-php-fpm?style=flat-square)
 
-# Nginx PHP-FPM Docker image
 
-> 🐳 Full Docker image for Nginx PHP-FPM container created to run Laravel or any php based applications.
+#### **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.  
 
-- [Docker Hub](https://hub.docker.com/r/jkaninda/nginx-php-fpm)
+This image is ideal for developers looking for a streamlined, high-performance solution to deploy PHP applications with essential tools already integrated.
-- [Github](https://github.com/jkaninda/nginx-php-fpm)
 
-## PHP Versions:
+---
-- 8.4
+## **Links**  
-- 8.3
+- [Docker Hub](https://hub.docker.com/r/jkaninda/nginx-php-fpm)  
-- 8.2
+- [GitHub Repository](https://github.com/jkaninda/nginx-php-fpm)  
-- 8.1
-- 8.0
-- 7.4
-- 7.2
 
-## Specifications:
+## **Supported PHP Versions**  
+- 8.4  
+- 8.3  
+- 8.2  
+- 8.1  
+- 8.0  
+- 7.4  
+- 7.2  
 
-* Composer
+## **Specifications**  
-* OpenSSL PHP Extension
+This Docker image comes pre-installed with the following:  
-* XML PHP Extension
+- **PHP Extensions**:  
-* PDO PHP Extension
+  - Composer  
-* Rdkafka PHP Extension
+  - OpenSSL  
-* Redis PHP Extension
+  - XML  
-* Mbstring PHP Extension
+  - PDO  
-* PCNTL PHP Extension
+  - Rdkafka  
-* ZIP PHP Extension
+  - Redis  
-* GD PHP Extension
+  - Mbstring  
-* BCMath PHP Extension
+  - PCNTL  
-* Memcached
+  - ZIP  
-* Laravel Cron Job
+  - GD  
-* Laravel Schedule
+  - BCMath  
-* Supervisord
+  - Memcached  
-* Nodejs
-* NPM
 
-## Simple docker-compose usage:
+- **Additional Features**:  
+  - Laravel Cron Jobs & Scheduler  
+  - Supervisord  
+  - Node.js & NPM  
 
-```yml
+## **Basic Usage with Docker Compose**
+
+### **Example `docker-compose.yml`**
+```yaml
 services:
-    app:
+  app:
-        image: jkaninda/nginx-php-fpm:8.3
+    image: jkaninda/nginx-php-fpm:8.3
-        container_name: app
+    container_name: app
-        restart: unless-stopped 
+    restart: unless-stopped
-        user: www-data # Optional - for production usage    
+    user: www-data # Optional for production
-        volumes:
+    volumes:
-        #Project root
+      # Project root
-            - ./src:/var/www/html
+      - ./src:/var/www/html
-        ports:
+    ports:
-           - "80:80"
+      - "80:80"
-        networks:
+    networks:
-            - default #if you're using networks between containers
+      - default
+```
 
-```
+### **Commands**  
-## Docker:
+
-### Run
+#### Start the service:
 ```sh
- docker compose up -d
+docker compose up -d
 ```
-### Create Laravel project
+
+#### Create a new Laravel project:
 ```sh
 docker compose exec app composer create-project --prefer-dist laravel/laravel .
 ```
-### Artisan generate key
+
+#### Generate application key:
 ```sh
 docker compose exec app php artisan key:generate
 ```
-### Storage link
+
+#### Create a storage symlink:
 ```sh
 docker compose exec app php artisan storage:link
 ```
-### Fix permissions
+
+#### Fix storage and cache permissions:
 ```sh
 docker compose exec app chmod -R 777 storage bootstrap/cache
 ```
-### Laravel migration
+
+#### Run Laravel migrations:
 ```sh
- docker compose exec app php artisan migrate
+docker compose exec app php artisan migrate
 ```
-### 
+
+#### Access the container shell:
 ```sh
 docker exec -it app bash
-
 ```
 
-## Advanced Nignx-php-fpm:
+---
-### docker-compose.yml
+
-```yml
+## **Advanced Nginx PHP-FPM Setup**
+
+### **Extended `docker-compose.yml` Example**
+```yaml
 version: '3'
 services:
-    app:
+  app:
-        image: jkaninda/nginx-php-fpm
+    image: jkaninda/nginx-php-fpm
-        container_name: app
+    container_name: app
-        restart: unless-stopped 
+    restart: unless-stopped
-        ports:
+    ports:
-           - "80:80"    
+      - "80:80"
-        volumes:
+    volumes:
-        #Project root
+      # Project root
-            - ./:/var/www/html
+      - ./:/var/www/html
-            - ~/.ssh:/root/.ssh # If you use private CVS
+      - ~/.ssh:/root/.ssh # Use private CVS if needed
-             #./php.ini:/usr/local/etc/php/conf.d/php.ini # Optional, your custom php init file
+      # Optional custom PHP config
-        environment:
+      # - ./php.ini:/usr/local/etc/php/conf.d/php.ini
-           - APP_ENV=development # Optional, or production
+    environment:
-           - LARAVEL_PROCS_NUMBER=2 # Optional, Laravel queue:work process number
+      - APP_ENV=development # or production
-           #- CLIENT_MAX_BODY_SIZE=20M # Optional
+      - LARAVEL_PROCS_NUMBER=2 # Optional: Queue worker processes
-           #- DOMAIN=example.com # Optional
+      # - CLIENT_MAX_BODY_SIZE=20M # Optional
-           - DOCUMENT_ROOT=/var/www/html #Optional
+      # - DOMAIN=example.com # Optional
- 
+      - DOCUMENT_ROOT=/var/www/html # Optional
 ```
-Default web root:
+
+### **Default Web Root**  
 ```
 /var/www/html
 ```
 
+---
 
-## Docker run
+## **Custom Build Example**
-```sh
- docker compose up -d
 
-```
+### **Dockerfile**
-## Build from base
-Dockerfile
 ```Dockerfile
 FROM jkaninda/nginx-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
-# composer install / Optional
-#RUN composer install
 # Fix permissions
 RUN chown -R www-data:www-data /var/www/html
 
 USER www-data
 ```
 
+---
 
-## Nginx custom config:
+## **Custom Nginx Configuration**
-### Enable custom nginx config files
-> /var/www/html/conf/nginx/nginx.conf
 
-> /var/www/html/conf/nginx/nginx-site.conf
+To enable custom Nginx configurations, use the following files:  
+- `/var/www/html/conf/nginx/nginx.conf`  
+- `/var/www/html/conf/nginx/nginx-site.conf`  
 
-## Supervisord
+---
-### Add more 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.
+Supervisord can be used to manage tasks or processes within the container.  
-### Example:
+
+### **Example Configuration for Kafka Consumer**
 ```conf
 [program:kafkaconsume-worker]
 process_name=%(program_name)s_%(process_num)02d
@@ -171,14 +192,49 @@ redirect_stderr=true
 stdout_logfile=/var/www/html/storage/logs/kafka.log
 ```
 
-### Storage permision issue
+---
+
+## **Fixing Storage Permissions**  
+
+If you encounter storage permission issues, run the following commands:  
+
 ```sh
- docker compose exec php-fpm /bin/bash 
+docker compose exec php-fpm /bin/bash
- ```
-```sh
-chown -R www-data:www-data /var/www/html/
 ```
 
-> chmod -R 775 /var/www/html/storage
+Then inside the container:  
+```sh
+chown -R www-data:www-data /var/www/html/
+chmod -R 775 /var/www/html/storage
+```
+
+---
+
+### Explore Another Project: Goma Gateway
+
+Are you building a microservices architecture?
+Do you need a powerful yet lightweight API Gateway or a high-performance reverse proxy to secure and manage your services effortlessly?
+
+Check out my other project — **[Goma Gateway](https://github.com/jkaninda/goma-gateway)**.
+
+**Goma Gateway** is a high-performance, declarative API Gateway built for modern microservices. It comes with a rich set of built-in middleware, including:
+
+* Basic, JWT, OAuth2, LDAP, and ForwardAuth authentication
+* Caching and rate limiting
+* Bot detection
+* Built-in load balancing
+* Simple configuration with minimal overhead
+* ...and more!
+
+**Protocol support:** REST, GraphQL, gRPC, TCP, and UDP
+
+**Security:** Automatic HTTPS via Let’s Encrypt or use your own TLS certificates
+
+Whether you're managing internal APIs or exposing public endpoints, **Goma Gateway** helps you do it efficiently, securely, and with minimal complexity.
+
+---
+
+## ⭐️ **Support the Project**  
+If this project helped you, do not skip on giving it a star. Thanks!
+
 
-> P.S. please give a star if you like it :wink:

src/entrypoint.sh

@@ -1,104 +1,96 @@
 #!/bin/sh
 
+set -e
+
 echo ""
 echo "***********************************************************"
 echo " Starting NGINX PHP-FPM Docker Container                   "
 echo "***********************************************************"
 
-set -e
+# Logging functions
-set -e
+info()    { echo "[INFO] $*"; }
-info() {
+warning() { echo "[WARNING] $*"; }
-    { set +x; } 2> /dev/null
+fatal()   { echo "[ERROR] $*" >&2; exit 1; }
-    echo '[INFO] ' "$@"
+
-}
+ARTISAN_FILE="/var/www/html/artisan"
-warning() {
+SUPERVISOR_CONF_DIR="/etc/supervisor/conf.d"
-    { set +x; } 2> /dev/null
+NGINX_CONF_DIR="/etc/nginx/conf.d"
-    echo '[WARNING] ' "$@"
+CUSTOM_NGINX_CONF="/var/www/html/conf/nginx"
-}
+CUSTOM_SUPERVISOR_CONF="/var/www/html/conf/worker/supervisor.conf"
-fatal() {
+DOCUMENT_ROOT="/var/www/html/public"
-    { set +x; } 2> /dev/null
+
-    echo '[ERROR] ' "$@" >&2
+# Laravel Supervisor Setup
-    exit 1
+setup_laravel_supervisor() {
-}
+  info "Artisan file found, creating Laravel supervisor config"
-## Check if the artisan file exists
+  export DOCUMENT_ROOT
-if [ -f /var/www/html/artisan ]; then
+
-    info "Artisan file found, creating laravel supervisor config"
+  cat > "$SUPERVISOR_CONF_DIR/laravel-worker.conf" <<EOF
-    # Set DocumentRoot to the Laravel project directory
+[program:Laravel-scheduler]
-    export DOCUMENT_ROOT=/var/www/html/public
+process_name=%(program_name)s_%(process_num)02d
-    ##Create Laravel Scheduler process
+command=/bin/sh -c "while true; do (php /var/www/html/artisan schedule:run --verbose --no-interaction &); sleep 60; done"
-    TASK=/etc/supervisor/conf.d/laravel-worker.conf
+autostart=true
-    touch $TASK
+autorestart=true
-    cat > "$TASK" <<EOF
+numprocs=1
-    [program:Laravel-scheduler]
+user=$USER_NAME
-    process_name=%(program_name)s_%(process_num)02d
+stdout_logfile=/var/log/laravel_scheduler.out.log
-    command=/bin/sh -c "while [ true ]; do (php /var/www/html/artisan schedule:run --verbose --no-interaction &); sleep 60; done"
+redirect_stderr=true
-    autostart=true
+
-    autorestart=true
+[program:Laravel-worker]
-    numprocs=1
+process_name=%(program_name)s_%(process_num)02d
-    user=$USER_NAME
+command=php /var/www/html/artisan queue:work --sleep=3 --tries=3
-    stdout_logfile=/var/log/laravel_scheduler.out.log
+autostart=true
-    redirect_stderr=true
+autorestart=true
-    
+numprocs=$LARAVEL_PROCS_NUMBER
-    [program:Laravel-worker]
+user=$USER_NAME
-    process_name=%(program_name)s_%(process_num)02d
+redirect_stderr=true
-    command=php /var/www/html/artisan queue:work --sleep=3 --tries=3
+stdout_logfile=/var/log/laravel_worker.log
-    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"
-else
-    info  "artisan file not found"
-fi
 
-# Enable custom nginx config files if they exist
+  info "Laravel supervisor config created"
-if [ -f /var/www/html/conf/nginx/nginx.conf ]; then
+}
-  cp /var/www/html/conf/nginx/nginx.conf /etc/nginx/nginx.conf
-  info "Using custom nginx.conf"
-fi
 
-if [ -f /var/www/html/conf/nginx/nginx-site.conf ]; then
+# Nginx Config Setup
-  info "Custom nginx site config found"
+setup_nginx_config() {
-  rm /etc/nginx/conf.d/default.conf
+  if [ -f "$CUSTOM_NGINX_CONF/nginx.conf" ]; then
-  cp /var/www/html/conf/nginx/nginx-site.conf /etc/nginx/conf.d/default.conf
+    cp "$CUSTOM_NGINX_CONF/nginx.conf" /etc/nginx/nginx.conf
-  info "Start nginx with custom server config..."
+    info "Using custom nginx.conf"
+  fi
+
+  if [ -f "$CUSTOM_NGINX_CONF/nginx-site.conf" ]; then
+    info "Custom nginx site config found"
+    rm -f "$NGINX_CONF_DIR/default.conf"
+    cp "$CUSTOM_NGINX_CONF/nginx-site.conf" "$NGINX_CONF_DIR/default.conf"
+    info "Start nginx with custom server config..."
   else
-  info "nginx-site.conf not found"
+    info "nginx-site.conf not found"
-  info "If you want to use custom configs, create config file in /var/www/html/conf/nginx/nginx-site.conf"
+    info "If you want to use custom configs, create it at $CUSTOM_NGINX_CONF/nginx-site.conf"
-  info "Start nginx with default config..."
+    info "Start nginx with default config..."
-   rm -f /etc/nginx/conf.d/default.conf
+
-   TASK=/etc/nginx/conf.d/default.conf
+    cat > "$NGINX_CONF_DIR/default.conf" <<EOF
-   touch $TASK
+server {
-   cat > "$TASK"  <<EOF
-   server {
     listen 80 default_server;
-    listen [::]:80 default_server;  
+    listen [::]:80 default_server;
     server_name $DOMAIN;
-    # Add index.php to setup Nginx, PHP & PHP-FPM config
+    root $DOCUMENT_ROOT;
-    index index.php index.html index.htm index.nginx-debian.html;
+    index index.php index.html index.htm;
+
     error_log  /var/log/nginx/error.log;
     access_log /var/log/nginx/access.log;
-    root $DOCUMENT_ROOT;
+
-    # pass PHP scripts on Nginx to FastCGI (PHP-FPM) server
+    location ~ \.php\$ {
-    location ~ \.php$ {
         try_files \$uri =404;
-        fastcgi_split_path_info ^(.+\.php)(/.+)$;
+        fastcgi_split_path_info ^(.+\.php)(/.+)\$;
-        # Nginx php-fpm config:
         fastcgi_pass 127.0.0.1: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 $CLIENT_MAX_BODY_SIZE;
     server_tokens off;
 
-     # Hide PHP headers 
+    fastcgi_hide_header X-Powered-By;
-    fastcgi_hide_header X-Powered-By; 
     fastcgi_hide_header X-CF-Powered-By;
     fastcgi_hide_header X-Runtime;
 
@@ -106,27 +98,30 @@ if [ -f /var/www/html/conf/nginx/nginx-site.conf ]; then
         try_files \$uri \$uri/ /index.php\$is_args\$args;
         gzip_static on;
     }
-    location ~ \.css {
+
-    add_header  Content-Type    text/css;
+    location ~ \.css\$ { add_header Content-Type text/css; }
-    }
+    location ~ \.js\$ { add_header Content-Type application/x-javascript; }
-    location ~ \.js {
+
-    add_header  Content-Type    application/x-javascript;
+    location ~ /\.ht { deny all; }
-    }
+    location ~ /\.(svn|git|hg|bzr)/ { deny all; }
-  # deny access to Apache .htaccess on Nginx with PHP, 
-  # if Apache and Nginx document roots concur
-  location ~ /\.ht    {deny all;}
-	location ~ /\.svn/  {deny all;}
-	location ~ /\.git/  {deny all;}
-	location ~ /\.hg/   {deny all;}
-	location ~ /\.bzr/  {deny all;}
 }
 EOF
-fi
+  fi
-## Check if the supervisor config file exists
+}
-if [ -f /var/www/html/conf/worker/supervisor.conf ]; then
-    info "Custom supervisor config found"
-    cp /var/www/html/conf/worker/supervisor.conf /etc/supervisor/conf.d/supervisor.conf
-fi
-## Start Supervisord
-supervisord -c /etc/supervisor/supervisord.conf
 
+# Load custom supervisor config if exists
+load_custom_supervisor_config() {
+  if [ -f "$CUSTOM_SUPERVISOR_CONF" ]; then
+    info "Custom supervisor config found"
+    cp "$CUSTOM_SUPERVISOR_CONF" "$SUPERVISOR_CONF_DIR/supervisor.conf"
+  fi
+}
+
+# Main Execution
+[ -f "$ARTISAN_FILE" ] && setup_laravel_supervisor || info "artisan file not found"
+
+setup_nginx_config
+load_custom_supervisor_config
+
+# Start Supervisor
+supervisord -c /etc/supervisor/supervisord.conf