Update build test and README

.github/workflows/run-docker-compose-prod.yml

@@ -0,0 +1,38 @@
+name: Docker Compose Production Build
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test-docker:
+    runs-on: ubuntu-latest
+    services:
+      docker:
+        image: docker:26.0.0
+        options: --privileged
+    steps:
+      - uses: actions/checkout@v2
+      - name: Modify Dockerfile to disable USER www (which is not supported by GitHub Actions, as it runs as root)
+        run: |
+          sed -i '/USER www/s/^/#/' ./Dockerfile
+      - name: Set up Docker Compose
+        run: |
+          # Build the images and start the services
+          docker compose -f docker-compose.prod.yml up -d
+          # Ensure the database is ready
+          docker compose exec -T ogame-db bash -c 'until mariadb -h "ogame-db" -u "root" -p"toor" -e "SELECT 1"; do sleep 1; done'
+      - name: Set Permissions
+        run: docker compose exec -T ogame-app chmod -R 777 /var/www
+      - name: Copy .env
+        run: docker compose exec -T ogame-app cp .env.example .env
+      - name: Run Laravel setup commands
+        run: |
+          docker compose exec -T ogame-app composer install --no-dev
+          docker compose exec -T ogame-app php artisan key:generate
+      - name: Run DB Migrations
+        run: docker compose exec -T ogame-app php artisan migrate
+      - name: Run configuration cache commands
+        run: docker compose exec -T ogame-app php artisan cache:clear && docker compose exec -T ogame-app php artisan config:cache && docker compose exec -T ogame-app php artisan route:cache && docker compose exec -T ogame-app php artisan view:cache

.github/workflows/run-tests-docker-compose-prod.yml

@@ -1,4 +1,6 @@
 name: Docker Compose Production Build and Test
+# Note: This workflow will install ALL composer dependencies including dev packages in order to run tests.
+# The separate workflow "Docker Compose Production Build" will install only production dependencies and will not run tests.
 
 on:
   push:
@@ -15,8 +17,12 @@ jobs:
         options: --privileged
     steps:
       - uses: actions/checkout@v2
+      - name: Modify Dockerfile to disable USER www (which is not supported by GitHub Actions, as it runs as root)
+        run: |
+          sed -i '/USER www/s/^/#/' ./Dockerfile
       - name: Set up Docker Compose
         run: |
+          # Build the images and start the services
           docker compose -f docker-compose.prod.yml up -d
           # Ensure the database is ready
           docker compose exec -T ogame-db bash -c 'until mariadb -h "ogame-db" -u "root" -p"toor" -e "SELECT 1"; do sleep 1; done'

.github/workflows/run-tests-docker-compose.yml

@@ -15,8 +15,12 @@ jobs:
         options: --privileged
     steps:
       - uses: actions/checkout@v2
+      - name: Modify Dockerfile to disable USER www (which is not supported by GitHub Actions, as it runs as root)
+        run: |
+          sed -i '/USER www/s/^/#/' ./Dockerfile
       - name: Set up Docker Compose
         run: |
+          # Build the images and start the services
           docker compose -f docker-compose.yml up -d
           # Ensure the database is ready
           docker compose exec -T ogame-db bash -c 'until mariadb -h "ogame-db" -u "root" -p"toor" -e "SELECT 1"; do sleep 1; done'

Dockerfile

@@ -60,8 +60,8 @@ COPY . /var/www
 # Copy existing application directory permissions
 COPY --chown=www:www . /var/www
 
-# Change current user to www (not compatible with GitHub Actions)
-#USER www
+# Change current user to www (disabled when running through GitHub Actions)
+USER www
 
 # Expose port 9000 and start php-fpm server
 EXPOSE 9000

README.md

@@ -100,6 +100,8 @@ After completing the setup, visit http://localhost to access OGameX. You first n
 For production there is a separate docker-compose file that is used to run the application. This file is called `docker-compose.prod.yml`. This configuration contains
 several performance optimizations and security settings that are not present in the development configuration.
 
+***Caution:*** the production configuration is not yet fully optimized and should be used with caution. As an example, the database root user uses a default password which should be changed to something unique.
+
 1. Clone the repository.
 2. Copy `.env.example` to `.env`.
 3. Launch the project using Docker Compose:
@@ -115,7 +117,7 @@ several performance optimizations and security settings that are not present in
 
 5. Run Laravel setup commands to download composer dependencies, generate an encryption key, cache configuration and prepare the database:
   ```
-  $ composer install
+  $ composer install --no-dev
   $ php artisan key:generate
   $ php artisan migrate --force
   $ php artisan cache:clear && php artisan config:cache && php artisan route:cache && php artisan view:cache

docker-compose.prod.yml

@@ -10,7 +10,8 @@ services:
       context: .
       dockerfile: Dockerfile
       args:
-        OPCACHE_ENABLE: "1" # Enable opcache for production
+        OPCACHE_ENABLE: "1" # Enable opcache in production
+        USE_USER: ${USE_USER_ARG:-yes}  # Defaults to "yes". Set to "no" for GitHub Actions.
     image: digitalocean.com/php
     container_name: ogame-app
     restart: unless-stopped
@@ -37,7 +38,7 @@ services:
     networks:
       - app-network
 
-  #MySQL Service
+  #MariaDB Service
   ogame-db:
     image: mariadb:11.3.2-jammy
     container_name: ogame-db
@@ -46,8 +47,7 @@ services:
     volumes:
      - ogame-dbdata:/var/lib/mysql
      - ./mysql/my.cnf:/etc/mysql/my.cnf
-    ports:
-      - "3306:3306"
+    # MariaDB port is not exposed to the host machine in production.
     environment:
       MYSQL_DATABASE: laravel
       MYSQL_ROOT_PASSWORD: toor

docker-compose.yml

@@ -11,6 +11,7 @@ services:
       dockerfile: Dockerfile
       args:
         OPCACHE_ENABLE: "0"  # Disable opcache for development
+        USE_USER: ${USE_USER_ARG:-yes}  # Defaults to "yes". Set to "no" for GitHub Actions.
     image: digitalocean.com/php
     container_name: ogame-app
     restart: unless-stopped
@@ -37,7 +38,7 @@ services:
     networks:
       - app-network
 
-  #MySQL Service
+  #MariaDB Service
   ogame-db:
     image: mariadb:11.3.2-jammy
     container_name: ogame-db