Refactor environment variables and port configuration

nanoninja · nanoninja · commit cc648e9297a4 · 2025-03-25T08:56:46.000+01:00
This commit enhances the flexibility and organization of the environment:

1. Add port customization for all services:
   - Allow configuration of all service ports through environment variables
   - Provide sensible defaults to prevent conflicts
   - Enable running multiple instances of the project simultaneously

2. Replace PHP runtime configuration with INI file selection:
   - Add PHP_INI variable to select the appropriate configuration file
   - Remove redundant PHP_DISPLAY_ERRORS, PHP_MEMORY_LIMIT variables
   - Simplify configuration management by centralizing settings in INI files

3. Improve variable organization in .env files:
   - Group related variables together
   - Rename APP_NAME for better clarity (was PROJECT_NAME)
   - Standardize variable naming conventions

These changes improve the maintainability, flexibility, and clarity of the
environment configuration while reducing duplication and potential inconsistencies.
diff --git a/.env b/.env
@@ -1,51 +1,58 @@
 # Development environment configuration
-PROJECT_NAME=docker_nginx_php_mysql
+
+# Application configuration
+APP_NAME=docker_nginx_php_mysql
+APP_WORKSPACE=default
+APP_DIR=app
+APP_PUBLIC_DIR=$(APP_DIR)/public
 
 # Common settings
 NGINX_HOST=localhost
+NGINX_PORT=8000
+
+# Nginx SSL Certificate configuration
+NGINX_SSL_PORT=3000
+NGINX_SSL_COUNTRY=US
+NGINX_SSL_STATE=State
+NGINX_SSL_LOCALITY=City
+NGINX_SSL_ORGANIZATION=Organization
+NGINX_SSL_UNIT=IT
+NGINX_SSL_EMAIL=admin@example.com
+NGINX_SSL_DAYS=365
+NGINX_SSL_KEY_SIZE=4096
 
-# Service versions
+# PHP configuration
 PHP_VERSION=8.3
 PHP_TARGET=dev
-MYSQL_VERSION=9.2
+PHP_INI=php.prod.ini
+
+PHP_DISPLAY_ERRORS=1
+PHP_MEMORY_LIMIT=256M
+XDEBUG_ENABLED=1
 
 # MySQL configuration
+MYSQL_VERSION=9.2
 MYSQL_HOST=mysql
+MYSQL_PORT=8989
 MYSQL_DATABASE=test
 MYSQL_ROOT_USER=root
 MYSQL_ROOT_PASSWORD=root
 MYSQL_USER=dev
 MYSQL_PASSWORD=dev
 
 # PHPMyAdmin configuration
+PHPMYADMIN_PORT=8080
 PHPMYADMIN_PROFILE=dev
 PHPMYADMIN_USER=root
 PHPMYADMIN_PASSWORD=root
 PHPMYADMIN_UPLOAD_LIMIT=100M
 
-# Nginx SSL Certificate configuration
-NGINX_SSL_COUNTRY=US
-NGINX_SSL_STATE=State
-NGINX_SSL_LOCALITY=City
-NGINX_SSL_ORGANIZATION=Organization
-NGINX_SSL_UNIT=IT
-NGINX_SSL_EMAIL=admin@example.com
-NGINX_SSL_DAYS=365
-NGINX_SSL_KEY_SIZE=4096
-
-# PHP configuration
-PHP_DISPLAY_ERRORS=1
-PHP_MEMORY_LIMIT=256M
-XDEBUG_ENABLED=1
-
-# Application configuration
-APP_WORKSPACE=default
-APP_DIR=app
-APP_PUBLIC_DIR=$(APP_DIR)/public
-
 # MailHog configuration
 MAILHOG_SMTP_PORT=1025
 MAILHOG_UI_PORT=8025
 MAILHOG_STORAGE=memory
 MAILHOG_HOSTNAME=mailhog
 MAILHOG_CORS_ORIGIN=*
+
+# API documentation configuration
+APIDOCS_PORT=8081
diff --git a/.env.dev b/.env.dev
@@ -1,51 +1,58 @@
 # Development environment configuration
-PROJECT_NAME=docker_nginx_php_mysql
+
+# Application configuration
+APP_NAME=docker_nginx_php_mysql
+APP_WORKSPACE=default
+APP_DIR=app
+APP_PUBLIC_DIR=$(APP_DIR)/public
 
 # Common settings
 NGINX_HOST=localhost
+NGINX_PORT=8000
+
+# Nginx SSL Certificate configuration
+NGINX_SSL_PORT=3000
+NGINX_SSL_COUNTRY=US
+NGINX_SSL_STATE=State
+NGINX_SSL_LOCALITY=City
+NGINX_SSL_ORGANIZATION=Organization
+NGINX_SSL_UNIT=IT
+NGINX_SSL_EMAIL=admin@example.com
+NGINX_SSL_DAYS=365
+NGINX_SSL_KEY_SIZE=4096
 
-# Service versions
+# PHP configuration
 PHP_VERSION=8.3
 PHP_TARGET=dev
-MYSQL_VERSION=9.2
+PHP_INI=php.dev.ini
+
+PHP_DISPLAY_ERRORS=1
+PHP_MEMORY_LIMIT=256M
+XDEBUG_ENABLED=1
 
 # MySQL configuration
+MYSQL_VERSION=9.2
 MYSQL_HOST=mysql
+MYSQL_PORT=8989
 MYSQL_DATABASE=test
 MYSQL_ROOT_USER=root
 MYSQL_ROOT_PASSWORD=root
 MYSQL_USER=dev
 MYSQL_PASSWORD=dev
 
 # PHPMyAdmin configuration
+PHPMYADMIN_PORT=8080
 PHPMYADMIN_PROFILE=dev
 PHPMYADMIN_USER=root
 PHPMYADMIN_PASSWORD=root
 PHPMYADMIN_UPLOAD_LIMIT=100M
 
-# Nginx SSL Certificate configuration
-NGINX_SSL_COUNTRY=US
-NGINX_SSL_STATE=State
-NGINX_SSL_LOCALITY=City
-NGINX_SSL_ORGANIZATION=Organization
-NGINX_SSL_UNIT=IT
-NGINX_SSL_EMAIL=admin@example.com
-NGINX_SSL_DAYS=365
-NGINX_SSL_KEY_SIZE=4096
-
-# PHP configuration
-PHP_DISPLAY_ERRORS=1
-PHP_MEMORY_LIMIT=256M
-XDEBUG_ENABLED=1
-
-# Application configuration
-APP_WORKSPACE=default
-APP_DIR=app
-APP_PUBLIC_DIR=$(APP_DIR)/public
-
 # MailHog configuration
 MAILHOG_SMTP_PORT=1025
 MAILHOG_UI_PORT=8025
 MAILHOG_STORAGE=memory
 MAILHOG_HOSTNAME=mailhog
-MAILHOG_CORS_ORIGIN=*
+MAILHOG_CORS_ORIGIN=*
+
+# API documentation configuration
+APIDOCS_PORT=8081
diff --git a/.env.prod b/.env.prod
@@ -1,26 +1,17 @@
-# Production environment configuration
-PROJECT_NAME=docker_nginx_php_mysql
+# Development environment configuration
+
+# Application configuration
+APP_NAME=docker_nginx_php_mysql
+APP_WORKSPACE=default
+APP_DIR=app
+APP_PUBLIC_DIR=$(APP_DIR)/public
 
 # Common settings
 NGINX_HOST=localhost
-
-# Service versions
-PHP_VERSION=8.3
-PHP_TARGET=base
-MYSQL_VERSION=9.2
-
-# MySQL configuration
-MYSQL_HOST=mysql
-MYSQL_DATABASE=prod
-MYSQL_ROOT_USER=root
-MYSQL_ROOT_PASSWORD=secure_root_password
-MYSQL_USER=app
-MYSQL_PASSWORD=secure_app_password
-
-# PHPMyAdmin configuration
-PHPMYADMIN_PROFILE=none
+NGINX_PORT=8000
 
 # Nginx SSL Certificate configuration
+NGINX_SSL_PORT=3000
 NGINX_SSL_COUNTRY=US
 NGINX_SSL_STATE=State
 NGINX_SSL_LOCALITY=City
@@ -31,12 +22,37 @@ NGINX_SSL_DAYS=365
 NGINX_SSL_KEY_SIZE=4096
 
 # PHP configuration
-PHP_DISPLAY_ERRORS=0
-PHP_MEMORY_LIMIT=128M
-XDEBUG_ENABLED=0
-PHPMYADMIN_PROFILE=none
+PHP_VERSION=8.3
+PHP_TARGET=dev
+PHP_INI=php.prod.ini
 
-# Application configuration
-APP_WORKSPACE=default
-APP_DIR=app
-APP_PUBLIC_DIR=$(APP_DIR)/public
+PHP_DISPLAY_ERRORS=1
+PHP_MEMORY_LIMIT=256M
+XDEBUG_ENABLED=1
+
+# MySQL configuration
+MYSQL_VERSION=9.2
+MYSQL_HOST=mysql
+MYSQL_PORT=8989
+MYSQL_DATABASE=test
+MYSQL_ROOT_USER=root
+MYSQL_ROOT_PASSWORD=root
+MYSQL_USER=dev
+MYSQL_PASSWORD=dev
+
+# PHPMyAdmin configuration
+PHPMYADMIN_PORT=8080
+PHPMYADMIN_PROFILE=dev
+PHPMYADMIN_USER=root
+PHPMYADMIN_PASSWORD=root
+PHPMYADMIN_UPLOAD_LIMIT=100M
+
+# MailHog configuration
+MAILHOG_SMTP_PORT=1025
+MAILHOG_UI_PORT=8025
+MAILHOG_STORAGE=memory
+MAILHOG_HOSTNAME=mailhog
+MAILHOG_CORS_ORIGIN=*
+
+# API documentation configuration
+APIDOCS_PORT=8081
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -17,7 +17,7 @@ services:
             - MYSQL_USER=${MYSQL_USER}
             - MYSQL_PASSWORD=${MYSQL_PASSWORD}
         ports:
-            - "8989:3306"
+            - "${MYSQL_PORT:-8989}:3306"
         volumes:
             - mysql_data:/var/lib/mysql
             - ./docker/mysql/init:/docker-entrypoint-initdb.d
@@ -39,8 +39,8 @@ services:
             - "./etc/ssl:/etc/ssl"
             - "./web:/var/www/html"
         ports:
-            - "8000:80"
-            - "3000:443"
+            - "${NGINX_PORT:-8000}:80"
+            - "${NGINX_SSL_PORT:-3000}:443"
         environment:
             - NGINX_HOST=${NGINX_HOST}
             - APP_WORKSPACE=${APP_WORKSPACE:-default}
@@ -69,7 +69,7 @@ services:
                 PHP_TARGET: ${PHP_TARGET:-dev}
         restart: always
         volumes:
-            - "./etc/php/php.ini:/usr/local/etc/php/conf.d/99-custom.ini"
+            - "./etc/php/${PHP_INI:-php.dev.ini}:/usr/local/etc/php/conf.d/99-custom.ini"
             - "./web:/var/www/html"
         environment:
             - PHP_DISPLAY_ERRORS=${PHP_DISPLAY_ERRORS:-1}
@@ -87,7 +87,7 @@ services:
         image: phpmyadmin/phpmyadmin
         container_name: phpmyadmin
         ports:
-            - "8080:80"
+            - "${PHPMYADMIN_PORT:-8080}:80"
         environment:
             - PMA_ARBITRARY=1
             - PMA_HOST=${MYSQL_HOST}
@@ -108,13 +108,13 @@ services:
     mailhog:
         image: mailhog/mailhog
         ports:
-            - "${MAILHOG_SMTP_PORT:-1025}:1025"  # SMTP port for sending emails
-            - "${MAILHOG_UI_PORT:-8025}:8025"    # Web interface for viewing emails
+            - "${MAILHOG_SMTP_PORT:-1025}:1025"        # SMTP port for sending emails
+            - "${MAILHOG_UI_PORT:-8025}:8025"          # Web interface for viewing emails
         environment:
-            - MH_SMTP_BIND_ADDR=0.0.0.0:1025     # Binding address for the SMTP server
-            - MH_API_BIND_ADDR=0.0.0.0:8025      # Binding address for the API
-            - MH_UI_BIND_ADDR=0.0.0.0:8025       # Binding address for the user interface
-            - MH_STORAGE=${MAILHOG_STORAGE:-memory} # Storage method (memory, mongodb)
+            - MH_SMTP_BIND_ADDR=0.0.0.0:1025           # Binding address for the SMTP server
+            - MH_API_BIND_ADDR=0.0.0.0:8025            # Binding address for the API
+            - MH_UI_BIND_ADDR=0.0.0.0:8025             # Binding address for the user interface
+            - MH_STORAGE=${MAILHOG_STORAGE:-memory}    # Storage method (memory, mongodb)
             - MH_HOSTNAME=${MAILHOG_HOSTNAME:-mailhog} # Hostname to use for EHLO/HELO links
             - MH_CORS_ORIGIN=${MAILHOG_CORS_ORIGIN:-*} # CORS Configuration
         networks:
@@ -127,12 +127,12 @@ services:
         volumes:
             - "./docs/api/html:/usr/share/nginx/html:ro"
         ports:
-            - "8081:80"
+            - "${APIDOCS_PORT:-8081}:80"
         networks:
             - frontend-network
         profiles:
             - ${PHPMYADMIN_PROFILE:-dev}
 
 volumes:
     mysql_data:
-        name: ${PROJECT_NAME:-docker_nginx_php_mysql}_mysql_data
+        name: ${APP_NAME:-docker_nginx_php_mysql}_mysql_data
