New experimental docker image

[jbtronics]

New experimental docker image

There now is a new (still experimental) docker image of Part-DB: partdborg/part-db

Unlike the jbtronics/part-db1 image, which uses a classic apache and php-fpm setup, the new image is based on FrankenPHP a PHP application server based on Caddy.

The main advantage is that FrankenPHP supports a worker mode for PHP execution, where the initialized symfony kernel can be reused for multiple requests. On the classic PHP request model on apache, nginx, etc. the symfony kernel has to be loaded and reinitialized again on every request, which slow everything down.

So with the new FrankenPHP based docker image, everything should be much faster. First experiments showed something like 10 ms on the FrankenPHP image compared to 50 ms with the classical approach on pages with few database operations. So a pretty good improvement of request time.

Another advantage is that Caddy (the webserver FrankenPHP is based on) has very easy TLS handling, somethin which was not possible so easy with the old images. Based on the easy configuration Caddy can automatically create self-signed TLS certificates, use existing certificates or automatically request TLS certificates from a ACME provider like LetsEncrypt. That way setting up a secure access to Part-DB should become much easier.

It is planned that the new image should replace the old one in the future as the default image. However as it changes some things and especially the worker mode was never tested with Part-DB before, it is currently only experimental.

There are some changes to the current docker interface, so it is required to use some new docker compose configuration.
If you wanna try it out create a file named compose.yaml with the following content and modify it to your needs:

services:
  php:
    image: partdborg/part-db:edge
    restart: unless-stopped
    environment:
      SERVER_NAME: ${SERVER_NAME:-localhost}, php:80
      MERCURE_PUBLISHER_JWT_KEY: ${CADDY_MERCURE_JWT_SECRET:-!ChangeThisMercureHubJWTSecretKey!}
      MERCURE_SUBSCRIBER_JWT_KEY: ${CADDY_MERCURE_JWT_SECRET:-!ChangeThisMercureHubJWTSecretKey!}
      TRUSTED_PROXIES: ${TRUSTED_PROXIES:-[127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16](https://127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16)}
      TRUSTED_HOSTS: ^${SERVER_NAME:-example\.com|localhost}|php$$
      MERCURE_URL: ${CADDY_MERCURE_URL:-http://php/.well-known/mercure}
      MERCURE_PUBLIC_URL: https://${SERVER_NAME:-localhost}/.well-known/mercure
      MERCURE_JWT_SECRET: ${CADDY_MERCURE_JWT_SECRET:-!ChangeThisMercureHubJWTSecretKey!}

     # Add your env options here like normally
     DATABASE_URL: mysql://root:@host.docker.internal:3306/partdb?serverVersion=10.6.5-mariadb    

    volumes:
      - caddy_data:/data
      - caddy_config:/config
      - ./uploads:/var/www/html/uploads
      - ./public_media:/var/www/html/public/media
      - ./db:/var/www/html/var/db
    ports:
      # HTTP
      - target: 80
        published: 4080
        protocol: tcp
      # HTTPS
      - target: 443
        published: 4443
        protocol: tcp
      # HTTP/3
      - target: 443
        published: 4443
        protocol: udp
        
    extra_hosts:
      # Ensure that host.docker.internal is correctly defined on Linux
      - host.docker.internal:host-gateway
        
        
volumes:
  caddy_data:
  caddy_config:

This file might change in the future. You can start Part-DB then using docker compose up (not docker-compose)

Also beware that this is based on the development versions of Part-DB and automatically updates the database. So this version may contain errors and you should regulary do database backups!