health-check and migrate on boot (#25)

add a health check to the container
and option to artisan migrate on boot

Co-authored-by: Ruben Momoa <ruben.lobbes@lobbes.nl>
Reviewed-on: #25

.woodpecker/build_dev.yml

@@ -6,7 +6,7 @@ when:
     branch:
         exclude: [ main, master ]
     path:
-        include: [ '.woodpecker/build_dev.yml', 'build/*', 'Dockerfile' ]
+        include: [ '.woodpecker/build_dev.yml', 'build/*', 'Dockerfile', 'gen-tag-list.sh' ]
     event: [ push, manual ]
 
 steps:

.woodpecker/build_release.yml

@@ -1,9 +1,9 @@
 matrix:
     PHP_VERSION:
-        - 8
-        - 8.3
-        - 8.2
         - 8.1
+        - 8.2
+        - 8.3
+        - 8
 
 when:
     branch:
@@ -11,14 +11,21 @@ when:
     cron: nightly
     event: [ cron, release, manual ]
 
+clone:
+    git:
+        image: woodpeckerci/plugin-git
+        settings:
+            partial: true
+            tags: true
+
 steps:
     cron_pre_check:
         image: docker
         commands:
             - docker pull php:${PHP_VERSION}-fpm-alpine
-            - docker pull vistanarvas/simple-laravel:${PHP_VERSION}-fpm-alpine
+            - docker pull vistanarvas/simple-laravel:latest-php-${PHP_VERSION}
             - BASE_IMG=$(docker inspect php:${PHP_VERSION}-fpm-alpine --format='{{.Created}}' | cut -d '.' -f 1)
-            - PREV_IMG=$(docker inspect vistanarvas/simple-laravel:php-${PHP_VERSION} --format='{{.Created}}' | cut -d '.' -f 1)
+            - PREV_IMG=$(docker inspect vistanarvas/simple-laravel:latest-php-${PHP_VERSION} --format='{{.Created}}' | cut -d '.' -f 1)
             - BASE_DATE=$(date -D "%Y-%m-%dT%H:%M:%S" -d "$BASE_IMG" +%s)
             - PREV_DATE=$(date -D "%Y-%m-%dT%H:%M:%S" -d "$PREV_IMG" +%s)
             - if [ "$PREV_DATE" -gt "$BASE_DATE" ]; then echo "no rebuild needed"; exit 1; fi
@@ -28,6 +35,12 @@ steps:
             cron: nightly
             event: [ cron ]
 
+    gen_tags:
+        image: docker
+        commands:
+            - ./gen-tag-list.sh $(git describe --tags --abbrev=0) php-${PHP_VERSION}
+            - cat tags.txt
+
     release_alpine_build_and_publish:
         image: woodpeckerci/plugin-docker-buildx
         settings:
@@ -36,5 +49,6 @@ steps:
                 from_secret: DOCKERHUB_TOKEN
             context: ./build
             repo: vistanarvas/${CI_REPO_NAME}
-            auto_tag: true
-            auto_tag_suffix: -php-${PHP_VERSION}
+            tags_file: tags.txt
+            build_args:
+                - BASE_VERSION=${PHP_VERSION}

Dockerfile

@@ -5,6 +5,9 @@ FROM php:${BASE_VERSION}-fpm-alpine
 # port to for the webserver
 ENV WEBSERVER_PORT=8080
 
+# path without leading / (slash)
+ENV HEALTHCHECK_PATH=""
+
 COPY start-container.sh /usr/local/bin/start-container
 
 RUN apk add --no-cache \
@@ -25,11 +28,16 @@ RUN apk add --no-cache \
         php-exif \
         php-xmlwriter \
         php-tokenizer \
+        php-simplexml \
+        php-xmlreader \
         composer \
         npm \
     && docker-php-ext-install filter pdo_mysql \
     && chmod +x /usr/local/bin/start-container
 
+HEALTHCHECK --interval=5m --timeout=3s --start-period=5m --start-interval=10s \
+  CMD curl -f http://localhost:${WEBSERVER_PORT}/${HEALTHCHECK_PATH} || exit 1
+
 EXPOSE ${WEBSERVER_PORT}
 
 WORKDIR /var/www/html

Readme.md

@@ -1,11 +1,73 @@
+[![status-badge](https://woodpecker.narvas.tech/api/badges/1/status.svg)](https://woodpecker.narvas.tech/repos/1)
+
 # simple-laravel
 
+Get a Laravel server up and running quickly for testing and small-scale deployments with this lightweight Docker image.
 
+This image is designed to provide a hassle-free way to spin up a Laravel server for development, testing, and small-scale production environments. It's perfect for rapid prototyping, proof-of-concepts, and low-traffic web applications.
+
+Based on the official PHP image, ensuring a stable and secure foundation
+Pre-configured with Laravel and its dependencies, saving you time and effort
+Optimized for small-scale deployments, keeping resource usage to a minimum
+Easy to use and extend, with a simple and intuitive configuration
+
+## tags
+This image follows a similar tagging schema as the official PHP image.  
+`{simple-laravel version}-php-{php version} (e.g. vistanarvas/simple-laravel:2.0.2-php-8.3)`
 
 ## setting laravel up in a container
 
+### compose
+
+```yaml
+version: '3'
+services:
+    app:
+        image: vistanarvas/simple-laravel
+        ports:
+            - '8080:8080'
+            - '5173:5173'
+        environment:
+            DB_CONNECTION: mysql
+            DB_HOST: mysql
+            DB_PORT: 3306
+            DB_DATABASE: laravel
+            DB_USERNAME: laravel
+            DB_PASSWORD: password
+
+            BOOT_COMPOSER_INSTALL: true # runs `composer install` on boot
+            BOOT_NPM_INSTALL: true      # runs `npm install` on boot
+            BOOT_NPM_DEV: true          # starts `npm dev`
+
+            # Extra packages and php extensions to install on first boot
+            # EXTRA_APK_PACKAGES:   # example: libpng-dev icu-dev
+            # EXTRA_PHP_EXTENSIONS: # example: exif intl bcmath gd pdo_mysql
+        volumes:
+            - '[Path to your laravel project]:/var/www/html'
+        depends_on:
+            - mysql
+
+    mysql:
+        image: 'mysql/mysql-server:8.0'
+        environment:
+            MYSQL_ROOT_PASSWORD: root_password
+            MYSQL_ROOT_HOST: '%'
+            MYSQL_DATABASE: laravel
+            MYSQL_USER: laravel
+            MYSQL_PASSWORD: password
+            MYSQL_ALLOW_EMPTY_PASSWORD: 1
+        volumes:
+            - 'mysql:/var/lib/mysql'
+
+volumes:
+    mysql:
+        driver: local
+```
+
+## suggested changes to laravel
+
 ### vite
-edit `/vite.config.js`
+`/vite.config.js`
 ```diff
  import laravel from 'laravel-vite-plugin';
  
@@ -20,9 +82,8 @@ edit `/vite.config.js`
              input: [
 
 ```
-
-edit `/package.json`
-
+---
+`/package.json`
 ```diff
      "private": true,
      "type": "module",

build/start-container.sh

@@ -3,8 +3,13 @@
 # exit when any command fails
 set -e
 
+if [ ! -f /var/www/html/artisan ]; then
+    echo "No existing Laravel project found"
+    exit
+fi
+
 # install extra packages and extensions on first boot
-if [[ ! -f /etc/first_boot ]]; then
+if [[ $(id -u) -eq 0 && ! -f /etc/first_boot ]]; then
     if [[ -n "${EXTRA_APK_PACKAGES// /}" ]]; then
         # shellcheck disable=SC2086
         apk add --no-cache $EXTRA_APK_PACKAGES
@@ -23,12 +28,12 @@ fi
 
 if [[ "$BOOT_NPM_INSTALL" = true ]]; then
     echo "npm install"
-    npm install
+    npm install --cache /tmp/npm
 fi
 
-if [ ! -f /var/www/html/artisan ]; then
-    echo "No existing Laravel project found"
-    exit
+if [[ "$BOOT_MIGRATE" = true ]]; then
+    echo "artisan migrate"
+    php /var/www/html/artisan migrate
 fi
 
 if [[ "$BOOT_NPM_DEV" = true ]]; then

docker-compose.yml

@@ -3,57 +3,40 @@ services:
     app:
         image: vistanarvas/simple-laravel
         ports:
-            - '8080:80'
+            - '8080:8080'
             - '5173:5173'
         environment:
-            WEBSERVER_PORT: 80
             DB_CONNECTION: mysql
             DB_HOST: mysql
             DB_PORT: 3306
             DB_DATABASE: laravel
             DB_USERNAME: laravel
             DB_PASSWORD: password
-            BOOT_NPM_DEV: true # also starts `npm dev`
-            BOOT_NPM_INSTALL: true # runs `npm install` on boot
+
             BOOT_COMPOSER_INSTALL: true # runs `composer install` on boot
+            BOOT_NPM_INSTALL: true      # runs `npm install` on boot
+            BOOT_NPM_DEV: true          # starts `npm dev`
 
             # Extra packages and php extensions to install on first boot
             # EXTRA_APK_PACKAGES:   # example: libpng-dev icu-dev
             # EXTRA_PHP_EXTENSIONS: # example: exif intl bcmath gd pdo_mysql
+        volumes:
+          - '[Path to your laravel project]:/var/www/html'
         depends_on:
             - mysql
-            - redis
-            - mailpit
 
     mysql:
         image: 'mysql/mysql-server:8.0'
-        ports:
-            - '3306:3306'
         environment:
-            MYSQL_ROOT_PASSWORD: '${DB_PASSWORD}'
+            MYSQL_ROOT_PASSWORD: root_password
             MYSQL_ROOT_HOST: '%'
-            MYSQL_DATABASE: '${DB_DATABASE}'
-            MYSQL_USER: '${DB_USERNAME}'
-            MYSQL_PASSWORD: '${DB_PASSWORD}'
+            MYSQL_DATABASE: laravel
+            MYSQL_USER: laravel
+            MYSQL_PASSWORD: password
             MYSQL_ALLOW_EMPTY_PASSWORD: 1
         volumes:
             - 'mysql:/var/lib/mysql'
 
-    redis:
-        image: 'redis:alpine'
-        ports:
-            - '6379:6379'
-        volumes:
-            - 'redis:/data'
-
-    mailpit:
-        image: 'axllent/mailpit:latest'
-        ports:
-            - '1025:1025'
-            - '8025:8025'
-
 volumes:
     mysql:
-        driver: local
-    redis:
-        driver: local
+        driver: local

gen-tag-list.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/env ash
+
+# this script generates a tags_file for Buildx (https://woodpecker-ci.org/plugins/Docker%20Buildx)
+
+# Check if a command-line argument is provided
+if [ -z "$1" ]; then
+  echo "Please provide a version as a command-line argument."
+  exit 1
+fi
+
+# Example v2.0.1
+version=$1
+
+# Suffix
+suffix=""
+if [[ -n $2 ]]; then
+    suffix="-$2"
+fi
+
+touch tags.txt
+if [[ "$2" = "php-8" ]]; then
+  echo "latest" >> tags.txt
+fi
+
+# Check if the first character is "V" or "v" and remove it
+if [[ "${version:0:1}" == "V" || "${version:0:1}" == "v" ]]; then
+  version="${version#?}"
+fi
+
+echo "latest$suffix" >> tags.txt
+echo "$version" | cut -d'.' -f1 | xargs -I {} echo "{}$suffix" >> tags.txt
+echo "$version" | cut -d'.' -f1,2 | xargs -I {} echo "{}$suffix" >> tags.txt
+echo "$version" | cut -d'.' -f1,2,3 | xargs -I {} echo "{}$suffix" >> tags.txt