Prepare for container version-3Variables (#133)

colisee · web-flow · commit cf57a0d67116 · 2025-11-30T09:50:41.000+01:00
* Prepare for container version-3

- Review documentation
- Stop setting config.php for librebooking &gt;= v4
- Stop disabling captcha by default
diff --git a/BUILD.md b/BUILD.md
@@ -33,17 +33,17 @@ This is the easiest and fastest way.
 
    ```sh
    # Set the application release (ex: develop or v4.0.0)
-   LB_RELEASE=develop
-   if [ "${LB_RELEASE}" == "develop" ]; then
-     APP_GH_REF="refs/heads/${LB_RELEASE}"
+   APP_RELEASE=develop
+   if [ "${APP_RELEASE}" == "develop" ]; then
+     APP_GH_REF="refs/heads/${APP_RELEASE}"
    else
-     APP_GH_REF="refs/tags/${LB_RELEASE}"
+     APP_GH_REF="refs/tags/${APP_RELEASE}"
    fi
 
    # Build the docker image
    docker buildx build \
      --build-arg APP_GH_REF=${APP_GH_REF} \
-     --tag librebooking/librebooking:$(echo ${LB_RELEASE} | sed -e "s/^v//") \
+     --tag librebooking/librebooking:$(echo ${APP_RELEASE} | sed -e "s/^v//") \
      --output type=docker \
      .
    ```
diff --git a/RUN.md b/RUN.md
@@ -1,31 +1,32 @@
 # Run the docker container
 
 The image contains the apache web server and the librebooking application files.
-It needs to be linked to a MariaDB database container.
+It needs to be linked to a running MariaDB database container.
 
 ## Environment variables
 
-The following environment variables are used when the file `/config/config.php`
-**does not exist**:
+From version-3, this docker image makes full usage of the
+[environment variables override](https://github.com/LibreBooking/app/blob/develop/docs/source/BASIC-CONFIGURATION.rst).
 
-| Env | Default | Example | Required | config.php settings |
-| - | - | - | - | - |
-| `LB_DB_NAME` | - | librebooking | **Yes** | `['settings']['database']['name']` |
-| `LB_DB_USER` | - | lb_user | **Yes** | `['settings']['database']['user']` |
-| `LB_DB_USER_PWD` | - | myPassw0rd | **Yes** | `['settings']['database']['password']` |
-| `LB_ENV` | production | devel | **No** | `['settings']['log']['level']` |
+### Required variables
 
-The following environment variables are **always** used:
+| Variable | Defaults | Description |
+| -------- | -------- | ----------- |
+| LB_DATABASE_NAME | | Database name |
+| LB_DATABASE_USER | | Database user |
+| LB_DATABASE_PASSWORD | | Database password |
+| LB_DATABASE_HOSTSPEC | | Database network address |
+| LB_INSTALL_PASSWORD | | Librebooking installation password |
+| LB_DEFAULT_TIMEZONE | | Timezone |
+| LB_LOGGING_FOLDER | `/var/log/librebooking` | Logs folder |
+| LB_LOGGING_LEVEL | `none` | Logging level |
+| LB_LOGGING_SQL | `false` | SQL logging |
 
-| Env | Default | Example | Required | config.php settings |
-| - | - | - | - | - |
-| `LB_DB_HOST` | - | lb-db | **Yes** | `['settings']['database']['hostspec']` |
-| `LB_INSTALL_PWD` | - | installPWD | **Yes** | `['settings']['install.password']` |
-| `TZ` | - | Europe/Zurich | **Yes** | `['settings']['default.timezone']` |
-| `LB_LOG_FOLDER` | /var/log/librebooking | | **No** | `['settings']['logging']['folder']` |
-| `LB_LOG_LEVEL` | none | debug | **No** | `['settings']['logging']['level']` |
-| `LB_LOG_SQL` | false | true | **No** | `['settings']['logging']['sql']` |
-| `LB_PATH` | - | book | **No** | N/A - URL path prefix (usually none) |
+### Optional variables
+
+| Variable | Description |
+| -------- | ----------- |
+| APP_PATH | URL path    |
 
 ## Optional mounts
 
@@ -63,9 +64,9 @@ where the:
     php -f /var/www/html/Jobs/sendreminders.php`
   ```
 
-Based on the value of the environment variable `LB_LOG_LEVEL`, the
+Based on the value of the environment variable `LB_LOGGING_LEVEL`, the
 background jobs will output to the `app.log` file inside the log
-folder defined by the environment variable `LB_LOG_FOLDER`.
+folder defined by the environment variable `LB_LOGGING_FOLDER`.
 
 ## Examples of running librebooking
 
@@ -103,16 +104,15 @@ This example is meant for testing the application within your private network.
      --network mynet \
      --publish 80:80 \
      --volume librebooking-conf:/config \
-     --env LB_DB_NAME=librebooking \
-     --env LB_DB_USER=lb_user \
-     --env LB_DB_USER_PWD=db_user_pwd \
-     --env LB_DB_HOST=librebooking-db \
-     --env LB_INSTALL_PWD=app_install_pwd \
-     --env LB_ENV=dev \
-     --env LB_LOG_FOLDER=/var/log/librebooking \
-     --env LB_LOG_LEVEL=DEBUG \
-     --env LB_LOG_SQL=false \
-     --env TZ=Europe/Zurich \
+     --env LB_DATABASE_NAME=librebooking \
+     --env LB_DATABASE_USER=lb_user \
+     --env LB_DATABASE_PASSWORD=db_user_pwd \
+     --env LB_DATABASE_HOSTSPEC=librebooking-db \
+     --env LB_INSTALL_PASSWORD=app_install_pwd \
+     --env LB_LOGGING_FOLDER=/var/log/librebooking \
+     --env LB_LOGGING_LEVEL=DEBUG \
+     --env LB_LOGGING_SQL=false \
+     --env LB_DEFAULT_TIMEZONE=Europe/Zurich \
     librebooking/librebooking:develop
    ```
 
@@ -124,15 +124,14 @@ This example is meant for testing the application within your private network.
      --detach \
      --network mynet \
      --volume librebooking-conf:/config \
-     --env LB_DB_NAME=librebooking \
-     --env LB_DB_USER=lb_user \
-     --env LB_DB_USER_PWD=db_user_pwd \
-     --env LB_DB_HOST=librebooking-db \
-     --env LB_ENV=dev \
-     --env LB_LOG_FOLDER=/var/log/librebooking \
-     --env LB_LOG_LEVEL=DEBUG \
-     --env LB_LOG_SQL=false \
-     --env TZ=Europe/Zurich \
+     --env LB_DATABASE_NAME=librebooking \
+     --env LB_DATABASE_USER=lb_user \
+     --env LB_DATABASE_PASSWORD=db_user_pwd \
+     --env LB_DATABASE_HOSTSPEC=librebooking-db \
+     --env LB_LOGGING_FOLDER=/var/log/librebooking \
+     --env LB_LOGGING_LEVEL=DEBUG \
+     --env LB_LOGGING_SQL=false \
+     --env LB_DEFAULT_TIMEZONE=Europe/Zurich \
     librebooking/librebooking:develop
    ```
 
@@ -167,16 +166,15 @@ value of the environment variables to your needs:
        volumes:
          - app_conf:/config
        environment:
-         - LB_DB_NAME=librebooking
-         - LB_DB_USER=lb_user
-         - LB_DB_USER_PWD=db_user_pwd
-         - LB_DB_HOST=db
-         - LB_INSTALL_PWD=app_install_pwd
-         - LB_ENV=dev
-         - LB_LOG_FOLDER=/var/log/librebooking
-         - LB_LOG_LEVEL=DEBUG
-         - LB_LOG_SQL=false
-         - TZ=Europe/Zurich
+         - LB_DATABASE_NAME=librebooking
+         - LB_DATABASE_USER=lb_user
+         - LB_DATABASE_PASSWORD=db_user_pwd
+         - LB_DATABASE_HOSTSPEC=db
+         - LB_INSTALL_PASSWORD=app_install_pwd
+         - LB_LOGGING_FOLDER=/var/log/librebooking
+         - LB_LOGGING_LEVEL=DEBUG
+         - LB_LOGGING_SQL=false
+         - LB_DEFAULT_TIMEZONE=Europe/Zurich
      jobs:
        image: librebooking/librebooking:develop
        restart: always
@@ -187,15 +185,14 @@ value of the environment variables to your needs:
        volumes:
          - app_conf:/config
        environment:
-         - LB_DB_NAME=librebooking
-         - LB_DB_USER=lb_user
-         - LB_DB_USER_PWD=db_user_pwd
-         - LB_DB_HOST=db
-         - LB_ENV=dev
-         - LB_LOG_FOLDER=/var/log/librebooking
-         - LB_LOG_LEVEL=DEBUG
-         - LB_LOG_SQL=false
-         - TZ=Europe/Zurich
+         - LB_DATABASE_NAME=librebooking
+         - LB_DATABASE_USER=lb_user
+         - LB_DATABASE_PASSWORD=db_user_pwd
+         - LB_DATABASE_HOSTSPEC=db
+         - LB_LOGGING_FOLDER=/var/log/librebooking
+         - LB_LOGGING_LEVEL=DEBUG
+         - LB_LOGGING_SQL=false
+         - LB_DEFAULT_TIMEZONE=Europe/Zurich
 
    volumes:
      db_conf:
@@ -272,17 +269,16 @@ the value of the environment variables to your needs:
        volumes:
          - lb1_conf:/config
        environment:
-         - LB_DB_NAME=lb1
-         - LB_INSTALL_PWD_FILE=/run/secrets/lb_install_pwd
-         - LB_DB_USER=lb1
-         - LB_DB_USER_PWD_FILE=/run/secrets/lb_user_pwd
-         - LB_DB_HOST=db
-         - LB_ENV=production
-         - LB_LOG_FOLDER=/var/log/librebooking
-         - LB_LOG_LEVEL=ERROR
-         - LB_LOG_SQL=false
-         - LB_PATH=book
-         - TZ=Europe/Zurich
+         - APP_PATH=book
+         - LB_DATABASE_NAME=lb1
+         - LB_INSTALL_PASSWORD_FILE=/run/secrets/lb_install_pwd
+         - LB_DATABASE_USER=lb1
+         - LB_DATABASE_PASSWORD_FILE=/run/secrets/lb_user_pwd
+         - LB_DATABASE_HOSTSPEC=db
+         - LB_LOGGING_FOLDER=/var/log/librebooking
+         - LB_LOGGING_LEVEL=ERROR
+         - LB_LOGGING_SQL=false
+         - LB_DEFAULT_TIMEZONE=Europe/Zurich
          - VIRTUAL_HOST=acme.org
          - VIRTUAL_PATH=/book
          - LETSENCRYPT_HOST=acme.org
@@ -299,14 +295,14 @@ the value of the environment variables to your needs:
        volumes:
          - lb1_conf:/config
        environment:
-         - LB_DB_NAME=lb1
-         - LB_DB_USER=lb1
-         - LB_DB_USER_PWD_FILE=/run/secrets/lb_user_pwd
-         - LB_DB_HOST=db
-         - LB_LOG_FOLDER=/var/log/librebooking
-         - LB_LOG_LEVEL=ERROR
-         - LB_LOG_SQL=false
-         - TZ=Europe/Zurich
+         - LB_DATABASE_NAME=lb1
+         - LB_DATABASE_USER=lb1
+         - LB_DATABASE_PASSWORD_FILE=/run/secrets/lb_user_pwd
+         - LB_DATABASE_HOSTSPEC=db
+         - LB_LOGGING_FOLDER=/var/log/librebooking
+         - LB_LOGGING_LEVEL=ERROR
+         - LB_LOGGING_SQL=false
+         - LB_DEFAULT_TIMEZONE=Europe/Zurich
        secrets:
          - lb_user_pwd
      lb2:
@@ -319,16 +315,15 @@ the value of the environment variables to your needs:
          - ./uploads/images:/var/www/html/Web/uploads/images
          - ./uploads/reservation:/var/www/html/Web/uploads/reservation
        environment:
-         - LB_DB_NAME=lb2
-         - LB_INSTALL_PWD_FILE=/run/secrets/lb_install_pwd
-         - LB_DB_USER=lb2
-         - LB_DB_USER_PWD_FILE=/run/secrets/lb_user_pwd
-         - LB_DB_HOST=db
-         - LB_ENV=production
-         - LB_LOG_FOLDER=/var/log/librebooking
-         - LB_LOG_LEVEL=ERROR
-         - LB_LOG_SQL=false
-         - TZ=Europe/Zurich
+         - LB_DATABASE_NAME=lb2
+         - LB_INSTALL_PASSWORD_FILE=/run/secrets/lb_install_pwd
+         - LB_DATABASE_USER=lb2
+         - LB_DATABASE_PASSWORD_FILE=/run/secrets/lb_user_pwd
+         - LB_DATABASE_HOSTSPEC=db
+         - LB_LOGGING_FOLDER=/var/log/librebooking
+         - LB_LOGGING_LEVEL=ERROR
+         - LB_LOGGING_SQL=false
+         - LB_DEFAULT_TIMEZONE=Europe/Zurich
          - VIRTUAL_HOST=acme.org
          - LETSENCRYPT_HOST=acme.org
        secrets:
@@ -344,14 +339,14 @@ the value of the environment variables to your needs:
        volumes:
          - lb2_conf:/config
        environment:
-         - LB_DB_NAME=lb2
-         - LB_DB_USER=lb2
-         - LB_DB_USER_PWD_FILE=/run/secrets/lb_user_pwd
-         - LB_DB_HOST=db
-         - LB_LOG_FOLDER=/var/log/librebooking
-         - LB_LOG_LEVEL=ERROR
-         - LB_LOG_SQL=false
-         - TZ=Europe/Zurich
+         - LB_DATABASE_NAME=lb2
+         - LB_DATABASE_USER=lb2
+         - LB_DATABASE_PASSWORD_FILE=/run/secrets/lb_user_pwd
+         - LB_DATABASE_HOSTSPEC=db
+         - LB_LOGGING_FOLDER=/var/log/librebooking
+         - LB_LOGGING_LEVEL=ERROR
+         - LB_LOGGING_SQL=false
+         - LB_DEFAULT_TIMEZONE=Europe/Zurich
        secrets:
          - lb_user_pwd
 
diff --git a/bin/cron.sh b/bin/cron.sh
@@ -2,11 +2,10 @@
 set -eu
 
 # Constants
-readonly DFT_LOG_FLR="/var/log/librebooking"
-readonly DFT_LOG_LEVEL="none"
-readonly DFT_LOG_SQL=false
-readonly DFT_LB_ENV="production"
-readonly DFT_LB_PATH=""
+readonly DFT_LOGGING_FLR="/var/log/librebooking"
+readonly DFT_LOGGING_LEVEL="none"
+readonly DFT_LOGGING_SQL=false
+readonly DFT_APP_PATH=""
 
 file_env() {
   local var="$1"
@@ -31,17 +30,16 @@ file_env() {
 # Initialize variables
 file_env LB_DB_USER_PWD
 
-LB_LOG_FOLDER=${LB_LOG_FOLDER:-${DFT_LOG_FLR}}
-LB_LOG_LEVEL=${LB_LOG_LEVEL:-${DFT_LOG_LEVEL}}
-LB_LOG_SQL=${LB_LOG_SQL:-${DFT_LOG_SQL}}
-LB_ENV=${LB_ENV:-${DFT_LB_ENV}}
-LB_PATH=${LB_PATH:-${DFT_LB_PATH}}
+LB_LOGGING_FOLDER=${LB_LOGGING_FOLDER:-${DFT_LOGGING_FLR}}
+LB_LOGGING_LEVEL=${LB_LOGGING_LEVEL:-${DFT_LOGGING_LEVEL}}
+LB_LOGGING_SQL=${LB_LOGGING_SQL:-${DFT_LOGGING_SQL}}
+APP_PATH=${APP_PATH:-${DFT_APP_PATH}}
 
 # Set the php timezone file
-if [ -f /usr/share/zoneinfo/${TZ} ]; then
+if [ -f /usr/share/zoneinfo/${LB_DEFAULT_TIMEZONE} ]; then
   INI_FILE="/usr/local/etc/php/conf.d/librebooking.ini"
   echo "[Date]" >> ${INI_FILE}
-  echo "date.timezone=\"${TZ}\"" >> ${INI_FILE}
+  echo "date.timezone=\"${LB_DEFAULT_TIMEZONE}\"" >> ${INI_FILE}
 fi
 
 # Link the configuration file
diff --git a/bin/entrypoint.sh b/bin/entrypoint.sh
