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

.env.example

@@ -1,19 +0,0 @@
-# the laravel version to install (empty for latest)
-LARAVEL_VERSION=
-
-# weather to run "npm dev run" at boot
-AUTO_START_NPM_DEV=true
-
-# external ports
-FORWARD_LARAVEL_PORT=80
-FORWARD_VITE_PORT=5173
-FORWARD_DB_PORT=3306
-FORWARD_REDIS_PORT=6379
-FORWARD_MAILPIT_PORT=1025
-FORWARD_MAILPIT_DASHBOARD_PORT=8025
-
-# DB settings (this will overwrite the defaults in the laravel project)
-DB_PORT=3306
-DB_DATABASE=laravel
-DB_USERNAME=laravel
-DB_PASSWORD=password

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "build/submodules/artisan-bash-completion"]
-	path = build/submodules/artisan-bash-completion
-	url = https://gitlab.com/balping/artisan-bash-completion.git

.woodpecker/build-dev.yaml

@@ -1,45 +0,0 @@
-when:
-  branch: dev
-
-steps:
-    update_submodule:
-        image: woodpeckerci/plugin-git
-        secrets:
-            -   source: gitea_token
-                target: GITEA_TOKEN
-            -   source: gitea_user
-                target: GITEA_USER
-        commands:
-            - git submodule update --remote
-            - if [ ! "$(git status --porcelain)" ]; then echo "no changes"; exit 0; fi
-            - git config user.name "$${GITEA_USER}"
-            - git config user.email "$${GITEA_USER}.gitea@narvas.tech"
-            - git add -A
-            - git commit -m "update submodules [skip ci]"
-            - git push "https://$${GITEA_USER}:$${GITEA_TOKEN}@git.narvas.tech/$${CI_REPO}"
-    check_base:
-        image: vistanarvas/container-update-checker:latest
-        secrets:
-            -   source: dockerhub_token
-                target: docker_password
-        environment:
-            DOCKER_USERNAME: vistanarvas
-            BASE: ubuntu:latest
-            TARGET: vistanarvas/${CI_REPO_NAME}:latest
-        when:
-            cron: nightly
-            event: cron
-    build_and_publish:
-        image: woodpeckerci/plugin-docker-buildx
-        settings:
-            username: vistanarvas
-            password:
-                from_secret: DOCKERHUB_TOKEN
-            context: ./build
-            repo: vistanarvas/${CI_REPO_NAME}
-            tag: dev
-        when:
-            path:
-                include: [ '.woodpecker/build-dev.yaml', 'build/*', 'Dockerfile' ]
-            cron: nightly
-            event: [push, cron, manual]

.woodpecker/build.yml

@@ -1,48 +0,0 @@
-when:
-  branch: master
-
-steps:
-    update_submodule:
-        image: woodpeckerci/plugin-git
-        secrets:
-            -   source: gitea_token
-                target: GITEA_TOKEN
-            -   source: gitea_user
-                target: GITEA_USER
-        commands:
-            - git submodule update --remote
-            - if [ ! "$(git status --porcelain)" ]; then echo "no changes"; exit 0; fi
-            - git config user.name "$${GITEA_USER}"
-            - git config user.email "$${GITEA_USER}.gitea@narvas.tech"
-            - git add -A
-            - git commit -m "update submodules [skip ci]"
-            - git push "https://$${GITEA_USER}:$${GITEA_TOKEN}@git.narvas.tech/$${CI_REPO}"
-        when:
-            cron: nightly
-            event: [push, tag, deployment, cron, manual]
-    check_base:
-        image: vistanarvas/container-update-checker:latest
-        secrets:
-            -   source: dockerhub_token
-                target: docker_password
-        environment:
-            DOCKER_USERNAME: vistanarvas
-            BASE: ubuntu:latest
-            TARGET: vistanarvas/${CI_REPO_NAME}:latest
-        when:
-            cron: nightly
-            event: cron
-    build_and_publish:
-        image: woodpeckerci/plugin-docker-buildx
-        settings:
-            username: vistanarvas
-            password:
-                from_secret: DOCKERHUB_TOKEN
-            context: ./build
-            repo: vistanarvas/${CI_REPO_NAME}
-            auto_tag: true
-        when:
-            path:
-                include: [ '.woodpecker/build.yml', 'build/*', 'Dockerfile' ]
-            cron: nightly
-            event: [push, tag, deployment, cron, manual]

.woodpecker/build_dev.yml

@@ -0,0 +1,23 @@
+matrix:
+    PHP_VERSION:
+        - 8
+
+when:
+    branch:
+        exclude: [ main, master ]
+    path:
+        include: [ '.woodpecker/build_dev.yml', 'build/*', 'Dockerfile', 'gen-tag-list.sh' ]
+    event: [ push, manual ]
+
+steps:
+    dev_alpine_build_and_publish:
+        image: woodpeckerci/plugin-docker-buildx
+        settings:
+            username: vistanarvas
+            password:
+                from_secret: DOCKERHUB_TOKEN
+            context: ./build
+            repo: vistanarvas/${CI_REPO_NAME}
+            tag: test-${CI_COMMIT_BRANCH}-php-${PHP_VERSION}
+            build_args:
+                - BASE_VERSION=${PHP_VERSION}

.woodpecker/build_release.yml

@@ -0,0 +1,54 @@
+matrix:
+    PHP_VERSION:
+        - 8.1
+        - 8.2
+        - 8.3
+        - 8
+
+when:
+    branch:
+        include: [ master ]
+    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: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: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
+        volumes:
+            - /var/run/docker.sock:/var/run/docker.sock
+        when:
+            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:
+            username: vistanarvas
+            password:
+                from_secret: DOCKERHUB_TOKEN
+            context: ./build
+            repo: vistanarvas/${CI_REPO_NAME}
+            tags_file: tags.txt
+            build_args:
+                - BASE_VERSION=${PHP_VERSION}

Dockerfile

@@ -1,44 +1,45 @@
-FROM ubuntu:latest
+ARG BASE_VERSION
 
-ARG USERNAME=laravel
-ARG USER_UID=1000
-ARG NODE_VERSION='' # node version number like "12.22.1" or empty for the latest version
-ARG COMPOSER_VERSION='' # composer version number like "2.1" or empty for the latest version
+FROM php:${BASE_VERSION}-fpm-alpine
 
-ENV NVM_DIR="/home/$USERNAME/.nvm"
+# 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
-COPY submodules/artisan-bash-completion/artisan /etc/bash_completion.d/artisan
 
-RUN export DEBIAN_FRONTEND=noninteractive \
-	&& apt-get -y update \
-	&& apt-get install -y curl git 7zip php php-xml php-curl php-xml php-mbstring php-mysql php-gd \
-	&& useradd --create-home --uid=$USER_UID $USERNAME \
-	&& chmod +x /usr/local/bin/start-container \
-	&& echo "install composer" \
-	&& curl -o composer-setup.php https://getcomposer.org/installer \
-	&& curl -o composer-setup.sig https://composer.github.io/installer.sig \
-	&& echo " composer-setup.php" >> composer-setup.sig \
-	&& sha384sum -c composer-setup.sig \
-	&& if [ -n "$COMPOSER_VERSION" ]; then COMPOSER_VERSION="--${COMPOSER_VERSION}"; fi \
-	&& php composer-setup.php --install-dir=/usr/local/bin --filename=composer $COMPOSER_VERSION \
-	&& rm composer-setup.php composer-setup.sig /var/www/html/* \
-	&& chown $USERNAME:$USERNAME /var/www/html \
-	&& echo 'alias artisan="php artisan"' >> /etc/bash.bashrc \
-	&& echo 'source /etc/bash_completion.d/*' >> /etc/bash.bashrc
+RUN apk add --no-cache \
+        curl-dev \
+        libxml2-dev \
+        oniguruma-dev \
+        libpng-dev \
+        icu-dev \
+        php-ctype \
+        php-curl \
+        php-dom \
+        php-fileinfo \
+        php-mbstring \
+        php-session \
+        php-xml \
+        php-intl \
+        php-bcmath \
+        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
 
-EXPOSE 8080
+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
 
-USER $USERNAME
-
-RUN echo "install nvm and node" \
-	&& curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash \
-	&& if [ -z "$NODE_VERSION" ]; then NODE_VERSION="node"; fi \
-	&& echo "source $NVM_DIR/nvm.sh" >> /home/$USERNAME/.bashrc \
-	&& [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" \
-	&& nvm install $NODE_VERSION \
-	&& nvm alias default $NODE_VERSION
-
 ENTRYPOINT ["start-container"]

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

@@ -1,27 +1,45 @@
-#!/usr/bin/env bash
+#!/usr/bin/env ash
 
 # exit when any command fails
 set -e
 
-# init nvm
-\. $NVM_DIR/nvm.sh
-
-
-if [[ "$INSTALL_BEFORE_START" = true ]]; then
-    echo "composer and npm install"
-    composer install
-    npm install
-fi
-
 if [ ! -f /var/www/html/artisan ]; then
     echo "No existing Laravel project found"
     exit
 fi
 
-if [[ "$AUTO_START_NPM_DEV" = true ]]; then
+# install extra packages and extensions on first boot
+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
+    fi
+    if [[ -n "${EXTRA_PHP_EXTENSIONS// /}" ]]; then
+        # shellcheck disable=SC2086
+        docker-php-ext-install $EXTRA_PHP_EXTENSIONS
+    fi
+    touch /etc/first_boot
+fi
+
+if [[ "$BOOT_COMPOSER_INSTALL" = true ]]; then
+    echo "composer install"
+    composer install
+fi
+
+if [[ "$BOOT_NPM_INSTALL" = true ]]; then
+    echo "npm install"
+    npm install --cache /tmp/npm
+fi
+
+if [[ "$BOOT_MIGRATE" = true ]]; then
+    echo "artisan migrate"
+    php /var/www/html/artisan migrate
+fi
+
+if [[ "$BOOT_NPM_DEV" = true ]]; then
     echo "Staring npm dev"
     npm run dev --prefix /var/www/html &
 fi
 
 echo "Staring Laravel"
-php /var/www/html/artisan serve
+php /var/www/html/artisan serve --host=0.0.0.0 --port="$WEBSERVER_PORT"

docker-compose.yml

@@ -1,54 +1,42 @@
 version: '3'
 services:
     app:
-        build:
-            context: build
-            dockerfile: Dockerfile
-        image: laravel
+        image: vistanarvas/simple-laravel
         ports:
-            - '${FORWARD_LARAVEL_PORT:-80}:8080'
-            - '${FORWARD_VITE_PORT:-5173}:5173'
+            - '8080:8080'
+            - '5173:5173'
         environment:
-            LARAVEL_VERSION: '${LARAVEL_VERSION}'
-            AUTO_START_NPM_DEV: '${AUTO_START_NPM_DEV:-false}'
-            DB_HOST: mysql
             DB_CONNECTION: mysql
-        env_file:
-            .env
+            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
-            - redis
-            - mailpit
 
     mysql:
         image: 'mysql/mysql-server:8.0'
-        ports:
-            - '${FORWARD_DB_PORT:-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:
-            - '${FORWARD_REDIS_PORT:-6379}:6379'
-        volumes:
-            - 'redis:/data'
-
-    mailpit:
-        image: 'axllent/mailpit:latest'
-        ports:
-            - '${FORWARD_MAILPIT_PORT:-1025}:1025'
-            - '${FORWARD_MAILPIT_DASHBOARD_PORT:-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