Bot Updating Package Versions

Add purifier directory to framework symlinks

.editorconfig

@@ -15,6 +15,6 @@ trim_trailing_whitespace = false
 indent_style = space
 indent_size = 2
 
-[{**.sh,root/etc/cont-init.d/**,root/etc/services.d/**}]
+[{**.sh,root/etc/s6-overlay/s6-rc.d/**,root/etc/cont-init.d/**,root/etc/services.d/**}]
 indent_style = space
 indent_size = 4

.github/CONTRIBUTING.md

@@ -6,7 +6,7 @@
 * Read, and fill the Pull Request template
   * If this is a fix for a typo (in code, documentation, or the README) please file an issue and let us sort it out. We do not need a PR
   * If the PR is addressing an existing issue include, closes #\<issue number>, in the body of the PR commit message
-* If you want to discuss changes, you can also bring it up in [#dev-talk](https://discordapp.com/channels/354974912613449730/757585807061155840) in our [Discord server](https://discord.gg/YWrKVTn)
+* If you want to discuss changes, you can also bring it up in [#dev-talk](https://discordapp.com/channels/354974912613449730/757585807061155840) in our [Discord server](https://linuxserver.io/discord)
 
 ## Common files
 
@@ -105,10 +105,10 @@ docker build \
   -t linuxserver/bookstack:latest .
 ```
 
-The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
+The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
 
 ```bash
-docker run --rm --privileged multiarch/qemu-user-static:register --reset
+docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
 ```
 
 Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.

.github/ISSUE_TEMPLATE/config.yml

@@ -1,7 +1,7 @@
 blank_issues_enabled: false
 contact_links:
   - name: Discord chat support
-    url: https://discord.gg/YWrKVTn
+    url: https://linuxserver.io/discord
     about: Realtime support / chat with the community and the team.
 
   - name: Discourse discussion forum

.github/ISSUE_TEMPLATE/issue.bug.md

@@ -1,40 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-
----
-[linuxserverurl]: https://linuxserver.io
-[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
-
-<!--- If you are new to Docker or this application our issue tracker is **ONLY** used for reporting bugs or requesting features. Please use [our discord server](https://discord.gg/YWrKVTn) for general support. --->
-
-<!--- Provide a general summary of the bug in the Title above -->
-
-------------------------------
-
-## Expected Behavior
-<!--- Tell us what should happen -->
-
-## Current Behavior
-<!--- Tell us what happens instead of the expected behavior -->
-
-## Steps to Reproduce
-<!--- Provide a link to a live example, or an unambiguous set of steps to -->
-<!--- reproduce this bug. Include code to reproduce, if relevant -->
-1.
-2.
-3.
-4.
-
-## Environment
-**OS:**
-**CPU architecture:** x86_64/arm32/arm64
-**How docker service was installed:**
-<!--- ie. from the official docker repo, from the distro repo, nas OS provided, etc. -->
-<!--- Providing context helps us come up with a solution that is most useful in the real world -->
-
-## Command used to create docker container (run/create/compose/screenshot)
-<!--- Provide your docker create/run command or compose yaml snippet, or a screenshot of settings if using a gui to create the container -->
-
-## Docker logs
-<!--- Provide a full docker log, output of "docker logs bookstack" -->

.github/ISSUE_TEMPLATE/issue.bug.yml

@@ -0,0 +1,76 @@
+# Based on the issue template
+name: Bug report
+description: Create a report to help us improve
+title: "[BUG] <title>"
+labels: [Bug]
+body:
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: Tell us what happens instead of the expected behavior.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: Tell us what should happen.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. In this environment...
+        2. With this config...
+        3. Run '...'
+        4. See error...
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Environment
+      description: |
+        examples:
+          - **OS**: Ubuntu 20.04
+          - **How docker service was installed**: distro's packagemanager
+      value: |
+        - OS:
+        - How docker service was installed:
+      render: markdown
+    validations:
+      required: false
+  - type: dropdown
+    attributes:
+      label: CPU architecture
+      options:
+        - x86-64
+        - arm64
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Docker creation
+      description: |
+        Command used to create docker container
+        Provide your docker create/run command or compose yaml snippet, or a screenshot of settings if using a gui to create the container
+      render: bash
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      description: |
+        Provide a full docker log, output of "docker logs bookstack"
+      label: Container logs
+      placeholder: |
+        Output of `docker logs bookstack`
+      render: bash
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/issue.feature.md

@@ -1,25 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-
----
-[linuxserverurl]: https://linuxserver.io
-[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
-
-<!--- If you are new to Docker or this application our issue tracker is **ONLY** used for reporting bugs or requesting features. Please use [our discord server](https://discord.gg/YWrKVTn) for general support. --->
-
-<!--- If this acts as a feature request please ask yourself if this modification is something the whole userbase will benefit from --->
-<!--- If this is a specific change for corner case functionality or plugins please look at making a Docker Mod or local script  https://blog.linuxserver.io/2019/09/14/customizing-our-containers/ -->
-
-<!--- Provide a general summary of the request in the Title above -->
-
-------------------------------
-
-## Desired Behavior
-<!--- Tell us what should happen -->
-
-## Current Behavior
-<!--- Tell us what happens instead of the expected behavior -->
-
-## Alternatives Considered
-<!--- Tell us what other options you have tried or considered -->

.github/ISSUE_TEMPLATE/issue.feature.yml

@@ -0,0 +1,31 @@
+# Based on the issue template
+name: Feature request
+description: Suggest an idea for this project
+title: "[FEAT] <title>"
+labels: [enhancement]
+body:
+  - type: checkboxes
+    attributes:
+      label: Is this a new feature request?
+      description: Please search to see if a feature request already exists.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: textarea
+    attributes:
+      label: Wanted change
+      description: Tell us what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Reason for change
+      description: Justify your request, why do you want it, what is the benefit.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Proposed code change
+      description: Do you have a potential code change in mind?
+    validations:
+      required: false

.github/workflows/call_issue_pr_tracker.yml

@@ -0,0 +1,19 @@
+name: Issue & PR Tracker
+
+on:
+  issues:
+    types: [opened,reopened,labeled,unlabeled,closed]
+  pull_request_target:
+    types: [opened,reopened,review_requested,review_request_removed,labeled,unlabeled,closed]
+  pull_request_review:
+    types: [submitted,edited,dismissed]
+
+permissions:
+  contents: read
+
+jobs:
+  manage-project:
+    permissions:
+      issues: write
+    uses: linuxserver/github-workflows/.github/workflows/issue-pr-tracker.yml@v1
+    secrets: inherit

.github/workflows/call_issues_cron.yml

@@ -0,0 +1,16 @@
+name: Mark stale issues and pull requests
+on:
+  schedule:
+    - cron:  '3 9 * * *'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  stale:
+    permissions:
+      issues: write
+      pull-requests: write
+    uses: linuxserver/github-workflows/.github/workflows/issues-cron.yml@v1
+    secrets: inherit

.github/workflows/external_trigger.yml

@@ -3,24 +3,42 @@ name: External Trigger Main
 on:
   workflow_dispatch:
 
+permissions:
+  contents: read
+
 jobs:
   external-trigger-master:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2.3.3
+      - uses: actions/checkout@v4.1.1
 
       - name: External Trigger
         if: github.ref == 'refs/heads/master'
+        env:
+          SKIP_EXTERNAL_TRIGGER: ${{ vars.SKIP_EXTERNAL_TRIGGER }}
         run: |
-          if [ -n "${{ secrets.PAUSE_EXTERNAL_TRIGGER_BOOKSTACK_MASTER }}" ]; then
+          printf "# External trigger for docker-bookstack\n\n" >> $GITHUB_STEP_SUMMARY
-            echo "**** Github secret PAUSE_EXTERNAL_TRIGGER_BOOKSTACK_MASTER is set; skipping trigger. ****"
+          if grep -q "^bookstack_master_" <<< "${SKIP_EXTERNAL_TRIGGER}"; then
+            echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY
+            echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` contains \`bookstack_master_\`; will skip trigger if version matches." >> $GITHUB_STEP_SUMMARY
+          elif grep -q "^bookstack_master" <<< "${SKIP_EXTERNAL_TRIGGER}"; then
+            echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
+            echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` contains \`bookstack_master\`; skipping trigger." >> $GITHUB_STEP_SUMMARY
             exit 0
           fi
-          echo "**** External trigger running off of master branch. To disable this trigger, set a Github secret named \"PAUSE_EXTERNAL_TRIGGER_BOOKSTACK_MASTER\". ****"
+          echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY
-          echo "**** Retrieving external version ****"
+          echo "> External trigger running off of master branch. To disable this trigger, add \`bookstack_master\` into the Github organizational variable \`SKIP_EXTERNAL_TRIGGER\`." >> $GITHUB_STEP_SUMMARY
+          printf "\n## Retrieving external version\n\n" >> $GITHUB_STEP_SUMMARY
           EXT_RELEASE=$(curl -u "${{ secrets.CR_USER }}:${{ secrets.CR_PAT }}" -sX GET "https://api.github.com/repos/bookstackapp/bookstack/releases/latest" | jq -r '. | .tag_name')
+          echo "Type is \`github_stable\`" >> $GITHUB_STEP_SUMMARY
+          if grep -q "^bookstack_master_${EXT_RELEASE}" <<< "${SKIP_EXTERNAL_TRIGGER}"; then
+            echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
+            echo "> Github organizational variable \`SKIP_EXTERNAL_TRIGGER\` matches current external release; skipping trigger." >> $GITHUB_STEP_SUMMARY
+            exit 0
+          fi
           if [ -z "${EXT_RELEASE}" ] || [ "${EXT_RELEASE}" == "null" ]; then
-            echo "**** Can't retrieve external version, exiting ****"
+            echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
+            echo "> Can't retrieve external version, exiting" >> $GITHUB_STEP_SUMMARY
             FAILURE_REASON="Can't retrieve external version for bookstack branch master"
             GHA_TRIGGER_URL="https://github.com/linuxserver/docker-bookstack/actions/runs/${{ github.run_id }}"
             curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680,
@@ -28,65 +46,102 @@ jobs:
               "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
             exit 1
           fi
-          EXT_RELEASE=$(echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g')
+          EXT_RELEASE_SANITIZED=$(echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g')
-          echo "**** External version: ${EXT_RELEASE} ****"
+          echo "Sanitized external version: \`${EXT_RELEASE_SANITIZED}\`" >> $GITHUB_STEP_SUMMARY
-          echo "**** Retrieving last pushed version ****"
+          echo "Retrieving last pushed version" >> $GITHUB_STEP_SUMMARY
           image="linuxserver/bookstack"
           tag="latest"
           token=$(curl -sX GET \
             "https://ghcr.io/token?scope=repository%3Alinuxserver%2Fbookstack%3Apull" \
             | jq -r '.token')
-            multidigest=$(curl -s \
+          multidigest=$(curl -s \
+            --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \
+            --header "Accept: application/vnd.oci.image.index.v1+json" \
+            --header "Authorization: Bearer ${token}" \
+            "https://ghcr.io/v2/${image}/manifests/${tag}")
+          if jq -e '.layers // empty' <<< "${multidigest}" >/dev/null 2>&1; then
+            # If there's a layer element it's a single-arch manifest so just get that digest
+            digest=$(jq -r '.config.digest' <<< "${multidigest}")
+          else
+            # Otherwise it's multi-arch or has manifest annotations
+            if jq -e '.manifests[]?.annotations // empty' <<< "${multidigest}" >/dev/null 2>&1; then
+              # Check for manifest annotations and delete if found
+              multidigest=$(jq 'del(.manifests[] | select(.annotations))' <<< "${multidigest}")
+            fi
+            if [[ $(jq '.manifests | length' <<< "${multidigest}") -gt 1 ]]; then
+              # If there's still more than one digest, it's multi-arch
+              multidigest=$(jq -r ".manifests[] | select(.platform.architecture == \"amd64\").digest?" <<< "${multidigest}")
+            else
+              # Otherwise it's single arch
+              multidigest=$(jq -r ".manifests[].digest?" <<< "${multidigest}")
+            fi
+            if digest=$(curl -s \
               --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \
+              --header "Accept: application/vnd.oci.image.manifest.v1+json" \
               --header "Authorization: Bearer ${token}" \
-              "https://ghcr.io/v2/${image}/manifests/${tag}" \
+              "https://ghcr.io/v2/${image}/manifests/${multidigest}"); then
-              | jq -r 'first(.manifests[].digest)')
+              digest=$(jq -r '.config.digest' <<< "${digest}");
-            digest=$(curl -s \
+            fi
-              --header "Accept: application/vnd.docker.distribution.manifest.v2+json" \
+          fi
-              --header "Authorization: Bearer ${token}" \
-              "https://ghcr.io/v2/${image}/manifests/${multidigest}" \
-              | jq -r '.config.digest')
           image_info=$(curl -sL \
             --header "Authorization: Bearer ${token}" \
-            "https://ghcr.io/v2/${image}/blobs/${digest}" \
+            "https://ghcr.io/v2/${image}/blobs/${digest}")
-            | jq -r '.container_config')
+          if [[ $(echo $image_info | jq -r '.container_config') == "null" ]]; then
+            image_info=$(echo $image_info | jq -r '.config')
+          else
+            image_info=$(echo $image_info | jq -r '.container_config')
+          fi
           IMAGE_RELEASE=$(echo ${image_info} | jq -r '.Labels.build_version' | awk '{print $3}')
           IMAGE_VERSION=$(echo ${IMAGE_RELEASE} | awk -F'-ls' '{print $1}')
           if [ -z "${IMAGE_VERSION}" ]; then
-            echo "**** Can't retrieve last pushed version, exiting ****"
+            echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
+            echo "Can't retrieve last pushed version, exiting" >> $GITHUB_STEP_SUMMARY
             FAILURE_REASON="Can't retrieve last pushed version for bookstack tag latest"
             curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680,
               "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}],
               "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
             exit 1
           fi
-          echo "**** Last pushed version: ${IMAGE_VERSION} ****"
+          echo "Last pushed version: \`${IMAGE_VERSION}\`" >> $GITHUB_STEP_SUMMARY
-          if [ "${EXT_RELEASE}" == "${IMAGE_VERSION}" ]; then
+          if [ "${EXT_RELEASE_SANITIZED}" == "${IMAGE_VERSION}" ]; then
-            echo "**** Version ${EXT_RELEASE} already pushed, exiting ****"
+            echo "Sanitized version \`${EXT_RELEASE_SANITIZED}\` already pushed, exiting" >> $GITHUB_STEP_SUMMARY
             exit 0
           elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/lastBuild/api/json | jq -r '.building') == "true" ]; then
-            echo "**** New version ${EXT_RELEASE} found; but there already seems to be an active build on Jenkins; exiting ****"
+            echo "New version \`${EXT_RELEASE}\` found; but there already seems to be an active build on Jenkins; exiting" >> $GITHUB_STEP_SUMMARY
             exit 0
           else
-            echo "**** New version ${EXT_RELEASE} found; old version was ${IMAGE_VERSION}. Triggering new build ****"
+            if [[ "${artifacts_found}" == "false" ]]; then
-            response=$(curl -iX POST \
+              echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
-              https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/buildWithParameters?PACKAGE_CHECK=false \
+              echo "> New version detected, but not all artifacts are published yet; skipping trigger" >> $GITHUB_STEP_SUMMARY
-              --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|")
+              FAILURE_REASON="New version ${EXT_RELEASE} for bookstack tag latest is detected, however not all artifacts are uploaded to upstream release yet. Will try again later."
-            echo "**** Jenkins job queue url: ${response%$'\r'} ****"
+              curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903,
-            echo "**** Sleeping 10 seconds until job starts ****"
+                "description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}],
-            sleep 10
+                "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
-            buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url')
+            else
-            buildurl="${buildurl%$'\r'}"
+              printf "\n## Trigger new build\n\n" >> $GITHUB_STEP_SUMMARY
-            echo "**** Jenkins job build url: ${buildurl} ****"
+              echo "New sanitized version \`${EXT_RELEASE_SANITIZED}\` found; old version was \`${IMAGE_VERSION}\`. Triggering new build" >> $GITHUB_STEP_SUMMARY
-            echo "**** Attempting to change the Jenkins job description ****"
+              if [[ "${artifacts_found}" == "true" ]]; then
-            curl -iX POST \
+                echo "All artifacts seem to be uploaded." >> $GITHUB_STEP_SUMMARY
-              "${buildurl}submitDescription" \
+              fi
-              --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \
+              response=$(curl -iX POST \
-              --data-urlencode "description=GHA external trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
+                https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/buildWithParameters?PACKAGE_CHECK=false \
-              --data-urlencode "Submit=Submit"
+                --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|")
-            echo "**** Notifying Discord ****"
+              echo "Jenkins [job queue url](${response%$'\r'})" >> $GITHUB_STEP_SUMMARY
-            TRIGGER_REASON="A version change was detected for bookstack tag latest. Old version:${IMAGE_VERSION} New version:${EXT_RELEASE}"
+              echo "Sleeping 10 seconds until job starts" >> $GITHUB_STEP_SUMMARY
-            curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903,
+              sleep 10
-              "description": "**Build Triggered** \n**Reason:** '"${TRIGGER_REASON}"' \n**Build URL:** '"${buildurl}display/redirect"' \n"}],
+              buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url')
-              "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
+              buildurl="${buildurl%$'\r'}"
+              echo "Jenkins job [build url](${buildurl})" >> $GITHUB_STEP_SUMMARY
+              echo "Attempting to change the Jenkins job description" >> $GITHUB_STEP_SUMMARY
+              curl -iX POST \
+                "${buildurl}submitDescription" \
+                --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \
+                --data-urlencode "description=GHA external trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
+                --data-urlencode "Submit=Submit"
+              echo "**** Notifying Discord ****"
+              TRIGGER_REASON="A version change was detected for bookstack tag latest. Old version:${IMAGE_VERSION} New version:${EXT_RELEASE_SANITIZED}"
+              curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903,
+                "description": "**Build Triggered** \n**Reason:** '"${TRIGGER_REASON}"' \n**Build URL:** '"${buildurl}display/redirect"' \n"}],
+                "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
+            fi
           fi

.github/workflows/external_trigger_scheduler.yml

@@ -2,42 +2,47 @@ name: External Trigger Scheduler
 
 on:
   schedule:
-    - cron:  '03 * * * *'
+    - cron:  '19 * * * *'
   workflow_dispatch:
 
+permissions:
+  contents: read
+
 jobs:
   external-trigger-scheduler:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2.3.3
+      - uses: actions/checkout@v4.1.1
         with:
           fetch-depth: '0'
 
       - name: External Trigger Scheduler
         run: |
-          echo "**** Branches found: ****"
+          printf "# External trigger scheduler for docker-bookstack\n\n" >> $GITHUB_STEP_SUMMARY
-          git for-each-ref --format='%(refname:short)' refs/remotes
+          printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY
-          echo "**** Pulling the yq docker image ****"
+          for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes)
-          docker pull ghcr.io/linuxserver/yq
-          for br in $(git for-each-ref --format='%(refname:short)' refs/remotes)
           do
-            br=$(echo "$br" | sed 's|origin/||g')
+            if [[ "${br}" == "HEAD" ]]; then
-            echo "**** Evaluating branch ${br} ****"
+              printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY
-            ls_branch=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/jenkins-vars.yml \
+              continue
-              | docker run --rm -i --entrypoint yq ghcr.io/linuxserver/yq -r .ls_branch)
+            fi
-            if [ "$br" == "$ls_branch" ]; then
+            printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY
-              echo "**** Branch ${br} appears to be live; checking workflow. ****"
+            ls_jenkins_vars=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/jenkins-vars.yml)
+            ls_branch=$(echo "${ls_jenkins_vars}" | yq -r '.ls_branch')
+            ls_trigger=$(echo "${ls_jenkins_vars}" | yq -r '.external_type')
+            if [[ "${br}" == "${ls_branch}" ]] && [[ "${ls_trigger}" != "os" ]]; then
+              echo "Branch appears to be live and trigger is not os; checking workflow." >> $GITHUB_STEP_SUMMARY
               if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then
-                echo "**** Workflow exists. Triggering external trigger workflow for branch ${br} ****."
+                echo "Triggering external trigger workflow for branch." >> $GITHUB_STEP_SUMMARY
                 curl -iX POST \
                   -H "Authorization: token ${{ secrets.CR_PAT }}" \
                   -H "Accept: application/vnd.github.v3+json" \
                   -d "{\"ref\":\"refs/heads/${br}\"}" \
                   https://api.github.com/repos/linuxserver/docker-bookstack/actions/workflows/external_trigger.yml/dispatches
               else
-                echo "**** Workflow doesn't exist; skipping trigger. ****"
+                echo "Skipping branch due to no external trigger workflow present." >> $GITHUB_STEP_SUMMARY
               fi
             else
-              echo "**** ${br} appears to be a dev branch; skipping trigger. ****"
+              echo "Skipping branch due to being detected as dev branch or having no external version." >> $GITHUB_STEP_SUMMARY
             fi
           done

.github/workflows/greetings.yml

@@ -2,12 +2,18 @@ name: Greetings
 
 on: [pull_request_target, issues]
 
+permissions:
+  contents: read
+
 jobs:
   greeting:
+    permissions:
+      issues: write
+      pull-requests: write
     runs-on: ubuntu-latest
     steps:
     - uses: actions/first-interaction@v1
       with:
-        issue-message: 'Thanks for opening your first issue here! Be sure to follow the [bug](https://github.com/linuxserver/docker-bookstack/blob/master/.github/ISSUE_TEMPLATE/issue.bug.md) or [feature](https://github.com/linuxserver/docker-bookstack/blob/master/.github/ISSUE_TEMPLATE/issue.feature.md) issue templates!'
+        issue-message: 'Thanks for opening your first issue here! Be sure to follow the relevant issue templates, or risk having this issue marked as invalid.'
         pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-bookstack/blob/master/.github/PULL_REQUEST_TEMPLATE.md)!'
         repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/package_trigger.yml

@@ -1,38 +0,0 @@
-name: Package Trigger Main
-
-on:
-  workflow_dispatch:
-
-jobs:
-  package-trigger-master:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2.3.3
-
-      - name: Package Trigger
-        if: github.ref == 'refs/heads/master'
-        run: |
-          if [ -n "${{ secrets.PAUSE_PACKAGE_TRIGGER_BOOKSTACK_MASTER }}" ]; then
-            echo "**** Github secret PAUSE_PACKAGE_TRIGGER_BOOKSTACK_MASTER is set; skipping trigger. ****"
-            exit 0
-          fi
-          if [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/lastBuild/api/json | jq -r '.building') == "true" ]; then
-            echo "**** There already seems to be an active build on Jenkins; skipping package trigger ****"
-            exit 0
-          fi
-          echo "**** Package trigger running off of master branch. To disable, set a Github secret named \"PAUSE_PACKAGE_TRIGGER_BOOKSTACK_MASTER\". ****"
-          response=$(curl -iX POST \
-            https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/buildWithParameters?PACKAGE_CHECK=true \
-            --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|")
-          echo "**** Jenkins job queue url: ${response%$'\r'} ****"
-          echo "**** Sleeping 10 seconds until job starts ****"
-          sleep 10
-          buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url')
-          buildurl="${buildurl%$'\r'}"
-          echo "**** Jenkins job build url: ${buildurl} ****"
-          echo "**** Attempting to change the Jenkins job description ****"
-          curl -iX POST \
-            "${buildurl}submitDescription" \
-            --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \
-            --data-urlencode "description=GHA package trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
-            --data-urlencode "Submit=Submit"

.github/workflows/package_trigger_scheduler.yml

@@ -2,49 +2,102 @@ name: Package Trigger Scheduler
 
 on:
   schedule:
-    - cron:  '51 15 * * 4'
+    - cron:  '4 18 * * 1'
   workflow_dispatch:
 
+permissions:
+  contents: read
+
 jobs:
   package-trigger-scheduler:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2.3.3
+      - uses: actions/checkout@v4.1.1
         with:
           fetch-depth: '0'
 
       - name: Package Trigger Scheduler
+        env:
+          SKIP_PACKAGE_TRIGGER: ${{ vars.SKIP_PACKAGE_TRIGGER }}
         run: |
-          echo "**** Branches found: ****"
+          printf "# Package trigger scheduler for docker-bookstack\n\n" >> $GITHUB_STEP_SUMMARY
-          git for-each-ref --format='%(refname:short)' refs/remotes
+          printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY
-          echo "**** Pulling the yq docker image ****"
+          for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes)
-          docker pull ghcr.io/linuxserver/yq
-          for br in $(git for-each-ref --format='%(refname:short)' refs/remotes)
           do
-            br=$(echo "$br" | sed 's|origin/||g')
+            if [[ "${br}" == "HEAD" ]]; then
-            echo "**** Evaluating branch ${br} ****"
+              printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY
-            ls_branch=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/jenkins-vars.yml \
+              continue
-              | docker run --rm -i --entrypoint yq ghcr.io/linuxserver/yq -r .ls_branch)
+            fi
-            if [ "${br}" == "${ls_branch}" ]; then
+            printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY
-              echo "**** Branch ${br} appears to be live; checking workflow. ****"
+            JENKINS_VARS=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/jenkins-vars.yml)
-              if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/.github/workflows/package_trigger.yml > /dev/null 2>&1; then
+            if ! curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/Jenkinsfile >/dev/null 2>&1; then
-                echo "**** Workflow exists. Triggering package trigger workflow for branch ${br}. ****"
+              echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
-                triggered_branches="${triggered_branches}${br} "
+              echo "> No Jenkinsfile found. Branch is either deprecated or is an early dev branch." >> $GITHUB_STEP_SUMMARY
-                curl -iX POST \
+              skipped_branches="${skipped_branches}${br} "
-                  -H "Authorization: token ${{ secrets.CR_PAT }}" \
+            elif [[ "${br}" == $(yq -r '.ls_branch' <<< "${JENKINS_VARS}") ]]; then
-                  -H "Accept: application/vnd.github.v3+json" \
+              echo "Branch appears to be live; checking workflow." >> $GITHUB_STEP_SUMMARY
-                  -d "{\"ref\":\"refs/heads/${br}\"}" \
+              README_VARS=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/readme-vars.yml)
-                  https://api.github.com/repos/linuxserver/docker-bookstack/actions/workflows/package_trigger.yml/dispatches
+              if [[ $(yq -r '.project_deprecation_status' <<< "${README_VARS}") == "true" ]]; then
-                sleep 30
+                echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
+                echo "> Branch appears to be deprecated; skipping trigger." >> $GITHUB_STEP_SUMMARY
+                skipped_branches="${skipped_branches}${br} "
+              elif [[ $(yq -r '.skip_package_check' <<< "${JENKINS_VARS}") == "true" ]]; then
+                echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
+                echo "> Skipping branch ${br} due to \`skip_package_check\` being set in \`jenkins-vars.yml\`." >> $GITHUB_STEP_SUMMARY
+                skipped_branches="${skipped_branches}${br} "
+              elif grep -q "^bookstack_${br}" <<< "${SKIP_PACKAGE_TRIGGER}"; then
+                echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
+                echo "> Github organizational variable \`SKIP_PACKAGE_TRIGGER\` contains \`bookstack_${br}\`; skipping trigger." >> $GITHUB_STEP_SUMMARY
+                skipped_branches="${skipped_branches}${br} "
+              elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/${br}/lastBuild/api/json | jq -r '.building' 2>/dev/null) == "true" ]; then
+                echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
+                echo "> There already seems to be an active build on Jenkins; skipping package trigger for ${br}" >> $GITHUB_STEP_SUMMARY
+                skipped_branches="${skipped_branches}${br} "
               else
-                echo "**** Workflow doesn't exist; skipping trigger. ****"
+                echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY
+                echo "> Triggering package trigger for branch ${br}" >> $GITHUB_STEP_SUMMARY
+                printf "> To disable, add \`bookstack_%s\` into the Github organizational variable \`SKIP_PACKAGE_TRIGGER\`.\n\n" "${br}" >> $GITHUB_STEP_SUMMARY
+                triggered_branches="${triggered_branches}${br} "
+                response=$(curl -iX POST \
+                  https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/${br}/buildWithParameters?PACKAGE_CHECK=true \
+                  --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|")
+                if [[ -z "${response}" ]]; then
+                  echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
+                  echo "> Jenkins build could not be triggered. Skipping branch."
+                  continue
+                fi
+                echo "Jenkins [job queue url](${response%$'\r'})" >> $GITHUB_STEP_SUMMARY
+                echo "Sleeping 10 seconds until job starts" >> $GITHUB_STEP_SUMMARY
+                sleep 10
+                buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url')
+                buildurl="${buildurl%$'\r'}"
+                echo "Jenkins job [build url](${buildurl})" >> $GITHUB_STEP_SUMMARY
+                echo "Attempting to change the Jenkins job description" >> $GITHUB_STEP_SUMMARY
+                if ! curl -ifX POST \
+                  "${buildurl}submitDescription" \
+                  --user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \
+                  --data-urlencode "description=GHA package trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
+                  --data-urlencode "Submit=Submit"; then
+                  echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
+                  echo "> Unable to change the Jenkins job description."
+                fi
+                sleep 20
               fi
             else
-              echo "**** ${br} appears to be a dev branch; skipping trigger. ****"
+              echo "Skipping branch ${br} due to being detected as dev branch." >> $GITHUB_STEP_SUMMARY
             fi
           done
-          echo "**** Package check build(s) triggered for branch(es): ${triggered_branches} ****"
+          if [[ -n "${triggered_branches}" ]] || [[ -n "${skipped_branches}" ]]; then
-          echo "**** Notifying Discord ****"
+            if [[ -n "${triggered_branches}" ]]; then
-          curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903,
+              NOTIFY_BRANCHES="**Triggered:** ${triggered_branches} \n"
-            "description": "**Package Check Build(s) Triggered for bookstack** \n**Branch(es):** '"${triggered_branches}"' \n**Build URL:** '"https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-bookstack/activity/"' \n"}],
+              NOTIFY_BUILD_URL="**Build URL:** https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-bookstack/activity/ \n"
-            "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
+              echo "**** Package check build(s) triggered for branch(es): ${triggered_branches} ****"
+            fi
+            if [[ -n "${skipped_branches}" ]]; then
+              NOTIFY_BRANCHES="${NOTIFY_BRANCHES}**Skipped:** ${skipped_branches} \n"
+            fi
+            echo "**** Notifying Discord ****"
+            curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903,
+              "description": "**Package Check Build(s) for bookstack** \n'"${NOTIFY_BRANCHES}"''"${NOTIFY_BUILD_URL}"'"}],
+              "username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
+          fi

.github/workflows/permissions.yml

@@ -0,0 +1,12 @@
+name: Permission check
+on:
+  pull_request_target:
+    paths:
+      - '**/run'
+      - '**/finish'
+      - '**/check'
+      - 'root/migrations/*'
+
+jobs:
+  permission_check:
+    uses: linuxserver/github-workflows/.github/workflows/init-svc-executable-permissions.yml@v1

.github/workflows/stale.yml

@@ -1,23 +0,0 @@
-name: Mark stale issues and pull requests
-
-on:
-  schedule:
-  - cron: "30 1 * * *"
-
-jobs:
-  stale:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/stale@v3
-      with:
-        stale-issue-message: "This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."
-        stale-pr-message: "This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."
-        stale-issue-label: 'no-issue-activity'
-        stale-pr-label: 'no-pr-activity'
-        days-before-stale: 30
-        days-before-close: 365
-        exempt-issue-labels: 'awaiting-approval,work-in-progress'
-        exempt-pr-labels: 'awaiting-approval,work-in-progress'
-        repo-token: ${{ secrets.GITHUB_TOKEN }}

Dockerfile

@@ -1,64 +1,66 @@
-FROM ghcr.io/linuxserver/baseimage-alpine-nginx:3.14
+# syntax=docker/dockerfile:1
+
+FROM ghcr.io/linuxserver/baseimage-alpine-nginx:3.23
 
 # set version label
 ARG BUILD_DATE
 ARG VERSION
 ARG BOOKSTACK_RELEASE
 LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
-LABEL maintainer="homerr"
+LABEL maintainer="thespad"
 
-# package versions
+ENV S6_STAGE2_HOOK="/init-hook"
-ARG BOOKSTACK_RELEASE
 
 RUN \
-  echo "**** install packages ****" && \
+  echo "**** install runtime packages ****" && \
-  apk add --no-cache  \
+  apk add --no-cache \
-    curl \
-    composer \
     fontconfig \
+    mariadb-client \
     memcached \
-    netcat-openbsd \
+    php85-dom \
-    php7-ctype \
+    php85-exif \
-    php7-curl \
+    php85-gd \
-    php7-dom \
+    php85-ldap \
-    php7-gd \
+    php85-mysqlnd \
-    php7-ldap \
+    php85-pdo_mysql \
-    php7-mbstring \
+    php85-pecl-memcached \
-    php7-memcached \
+    php85-tokenizer \
-    php7-mysqlnd \
-    php7-openssl \
-    php7-pdo_mysql \
-    php7-phar \
-    php7-simplexml \
-    php7-tokenizer \
     qt5-qtbase \
-    tar \
+    ttf-freefont && \
-    ttf-freefont \
+  echo "**** configure php-fpm to pass env vars ****" && \
-    wkhtmltopdf && \
+  sed -E -i 's/^;?clear_env ?=.*$/clear_env = no/g' /etc/php85/php-fpm.d/www.conf && \
-  echo "**** configure php-fpm ****" && \
+  if ! grep -qxF 'clear_env = no' /etc/php85/php-fpm.d/www.conf; then echo 'clear_env = no' >> /etc/php85/php-fpm.d/www.conf; fi && \
-  sed -i 's/;clear_env = no/clear_env = no/g' /etc/php7/php-fpm.d/www.conf && \
+  echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php85/php-fpm.conf && \
-  echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php7/php-fpm.conf && \
   echo "**** fetch bookstack ****" && \
   mkdir -p\
-    /var/www/html && \
+    /app/www && \
   if [ -z ${BOOKSTACK_RELEASE+x} ]; then \
     BOOKSTACK_RELEASE=$(curl -sX GET "https://api.github.com/repos/bookstackapp/bookstack/releases/latest" \
     | awk '/tag_name/{print $4;exit}' FS='[""]'); \
   fi && \
   curl -o \
-  /tmp/bookstack.tar.gz -L \
+    /tmp/bookstack.tar.gz -L \
     "https://github.com/BookStackApp/BookStack/archive/${BOOKSTACK_RELEASE}.tar.gz" && \
   tar xf \
-  /tmp/bookstack.tar.gz -C \
+    /tmp/bookstack.tar.gz -C \
-    /var/www/html/ --strip-components=1 && \
+    /app/www/ --strip-components=1 && \
   echo "**** install composer dependencies ****" && \
-  composer install -d /var/www/html/ && \
+  composer install -d /app/www/ && \
+  printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \
+  echo "**** create symlinks ****" && \
+  /bin/bash -c \
+  'dst=(www/themes www/files www/images www/uploads backups www/framework/cache www/framework/sessions www/framework/views www/framework/purifier log/bookstack/laravel.log www/.env); \
+  src=(themes storage/uploads/files storage/uploads/images public/uploads storage/backups storage/framework/cache storage/framework/sessions storage/framework/views storage/framework/purifier storage/logs/laravel.log .env); \
+  for i in "${!src[@]}"; do rm -rf /app/www/"${src[i]}" && ln -s /config/"${dst[i]}" /app/www/"${src[i]}"; done' && \
   echo "**** cleanup ****" && \
   rm -rf \
-    /root/.composer \
+    /tmp/* \
-    /tmp/*
+    $HOME/.cache \
+    $HOME/.composer
 
+# copy local files
 COPY root/ /
 
+# ports and volumes
+EXPOSE 80 443
 VOLUME /config
-EXPOSE 80

Dockerfile.aarch64

@@ -1,64 +1,66 @@
-FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm64v8-3.14
+# syntax=docker/dockerfile:1
+
+FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm64v8-3.23
 
 # set version label
 ARG BUILD_DATE
 ARG VERSION
 ARG BOOKSTACK_RELEASE
 LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
-LABEL maintainer="homerr"
+LABEL maintainer="thespad"
 
-# package versions
+ENV S6_STAGE2_HOOK="/init-hook"
-ARG BOOKSTACK_RELEASE
 
 RUN \
-  echo "**** install packages ****" && \
+  echo "**** install runtime packages ****" && \
-  apk add --no-cache  \
+  apk add --no-cache \
-    curl \
-    composer \
     fontconfig \
+    mariadb-client \
     memcached \
-    netcat-openbsd \
+    php85-dom \
-    php7-ctype \
+    php85-exif \
-    php7-curl \
+    php85-gd \
-    php7-dom \
+    php85-ldap \
-    php7-gd \
+    php85-mysqlnd \
-    php7-ldap \
+    php85-pdo_mysql \
-    php7-mbstring \
+    php85-pecl-memcached \
-    php7-memcached \
+    php85-tokenizer \
-    php7-mysqlnd \
-    php7-openssl \
-    php7-pdo_mysql \
-    php7-phar \
-    php7-simplexml \
-    php7-tokenizer \
     qt5-qtbase \
-    tar \
+    ttf-freefont && \
-    ttf-freefont \
+  echo "**** configure php-fpm to pass env vars ****" && \
-    wkhtmltopdf && \
+  sed -E -i 's/^;?clear_env ?=.*$/clear_env = no/g' /etc/php85/php-fpm.d/www.conf && \
-  echo "**** configure php-fpm ****" && \
+  if ! grep -qxF 'clear_env = no' /etc/php85/php-fpm.d/www.conf; then echo 'clear_env = no' >> /etc/php85/php-fpm.d/www.conf; fi && \
-  sed -i 's/;clear_env = no/clear_env = no/g' /etc/php7/php-fpm.d/www.conf && \
+  echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php85/php-fpm.conf && \
-  echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php7/php-fpm.conf && \
   echo "**** fetch bookstack ****" && \
   mkdir -p\
-    /var/www/html && \
+    /app/www && \
   if [ -z ${BOOKSTACK_RELEASE+x} ]; then \
     BOOKSTACK_RELEASE=$(curl -sX GET "https://api.github.com/repos/bookstackapp/bookstack/releases/latest" \
     | awk '/tag_name/{print $4;exit}' FS='[""]'); \
   fi && \
   curl -o \
-  /tmp/bookstack.tar.gz -L \
+    /tmp/bookstack.tar.gz -L \
     "https://github.com/BookStackApp/BookStack/archive/${BOOKSTACK_RELEASE}.tar.gz" && \
   tar xf \
-  /tmp/bookstack.tar.gz -C \
+    /tmp/bookstack.tar.gz -C \
-    /var/www/html/ --strip-components=1 && \
+    /app/www/ --strip-components=1 && \
   echo "**** install composer dependencies ****" && \
-  composer install -d /var/www/html/ && \
+  composer install -d /app/www/ && \
+  printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \
+  echo "**** create symlinks ****" && \
+  /bin/bash -c \
+  'dst=(www/themes www/files www/images www/uploads backups www/framework/cache www/framework/sessions www/framework/views www/framework/purifier log/bookstack/laravel.log www/.env); \
+  src=(themes storage/uploads/files storage/uploads/images public/uploads storage/backups storage/framework/cache storage/framework/sessions storage/framework/views storage/framework/purifier storage/logs/laravel.log .env); \
+  for i in "${!src[@]}"; do rm -rf /app/www/"${src[i]}" && ln -s /config/"${dst[i]}" /app/www/"${src[i]}"; done' && \
   echo "**** cleanup ****" && \
   rm -rf \
-    /root/.composer \
+    /tmp/* \
-    /tmp/*
+    $HOME/.cache \
+    $HOME/.composer
 
+# copy local files
 COPY root/ /
 
+# ports and volumes
+EXPOSE 80 443
 VOLUME /config
-EXPOSE 80

Dockerfile.armhf

@@ -1,64 +0,0 @@
-FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm32v7-3.14
-
-# set version label
-ARG BUILD_DATE
-ARG VERSION
-ARG BOOKSTACK_RELEASE
-LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
-LABEL maintainer="homerr"
-
-# package versions
-ARG BOOKSTACK_RELEASE
-
-RUN \
-  echo "**** install packages ****" && \
-  apk add --no-cache  \
-    curl \
-    composer \
-    fontconfig \
-    memcached \
-    netcat-openbsd \
-    php7-ctype \
-    php7-curl \
-    php7-dom \
-    php7-gd \
-    php7-ldap \
-    php7-mbstring \
-    php7-memcached \
-    php7-mysqlnd \
-    php7-openssl \
-    php7-pdo_mysql \
-    php7-phar \
-    php7-simplexml \
-    php7-tokenizer \
-    qt5-qtbase \
-    tar \
-    ttf-freefont \
-    wkhtmltopdf && \
-  echo "**** configure php-fpm ****" && \
-  sed -i 's/;clear_env = no/clear_env = no/g' /etc/php7/php-fpm.d/www.conf && \
-  echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php7/php-fpm.conf && \
-  echo "**** fetch bookstack ****" && \
-  mkdir -p\
-    /var/www/html && \
-  if [ -z ${BOOKSTACK_RELEASE+x} ]; then \
-    BOOKSTACK_RELEASE=$(curl -sX GET "https://api.github.com/repos/bookstackapp/bookstack/releases/latest" \
-    | awk '/tag_name/{print $4;exit}' FS='[""]'); \
-  fi && \
-  curl -o \
-  /tmp/bookstack.tar.gz -L \
-    "https://github.com/BookStackApp/BookStack/archive/${BOOKSTACK_RELEASE}.tar.gz" && \
-  tar xf \
-  /tmp/bookstack.tar.gz -C \
-    /var/www/html/ --strip-components=1 && \
-  echo "**** install composer dependencies ****" && \
-  composer install -d /var/www/html/ && \
-  echo "**** cleanup ****" && \
-  rm -rf \
-    /root/.composer \
-    /tmp/*
-
-COPY root/ /
-
-VOLUME /config
-EXPOSE 80

README.md

@@ -1,12 +1,10 @@
-<!-- DO NOT EDIT THIS FILE MANUALLY  -->
+<!-- DO NOT EDIT THIS FILE MANUALLY -->
-<!-- Please read the https://github.com/linuxserver/docker-bookstack/blob/master/.github/CONTRIBUTING.md -->
+<!-- Please read https://github.com/linuxserver/docker-bookstack/blob/master/.github/CONTRIBUTING.md -->
-
 [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
 
 [![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
-[![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.")
+[![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://linuxserver.io/discord "realtime support / chat with the community and the team.")
 [![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.")
-[![Fleet](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Fleet)](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
 [![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.")
 [![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
 
@@ -21,109 +19,123 @@ The [LinuxServer.io](https://linuxserver.io) team brings you another container r
 Find us at:
 
 * [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
-* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
+* [Discord](https://linuxserver.io/discord) - realtime support / chat with the community and the team.
 * [Discourse](https://discourse.linuxserver.io) - post on our community forum.
-* [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images.
 * [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.
 * [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget
 
 # [linuxserver/bookstack](https://github.com/linuxserver/docker-bookstack)
 
+[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fbookstack?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh)
 [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-bookstack.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-bookstack)
 [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-bookstack.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-bookstack/releases)
 [![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-bookstack/packages)
 [![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-bookstack/container_registry)
+[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/bookstack)
 [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/bookstack.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/bookstack)
 [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/bookstack.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/bookstack)
 [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-bookstack%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/)
-[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fbookstack%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/bookstack/latest/index.html)
 
-[Bookstack](https://github.com/BookStackApp/BookStack) is a free and open source Wiki designed for creating beautiful documentation. Feautring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
+[Bookstack](https://github.com/BookStackApp/BookStack) is a free and open source Wiki designed for creating beautiful documentation. Featuring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
 
 Powered by SQL and including a Markdown editor for those who prefer it, BookStack is geared towards making documentation more of a pleasure than a chore.
 
 For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
 
-[![bookstack](https://s3-us-west-2.amazonaws.com/linuxserver-docs/images/bookstack-logo500x500.png)](https://github.com/BookStackApp/BookStack)
+[![bookstack](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/bookstack-logo.png)](https://github.com/BookStackApp/BookStack)
 
 ## Supported Architectures
 
-Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
+We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
 
-Simply pulling `ghcr.io/linuxserver/bookstack` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
+Simply pulling `lscr.io/linuxserver/bookstack:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
 
 The architectures supported by this image are:
 
-| Architecture | Tag |
+| Architecture | Available | Tag |
-| :----: | --- |
+| :----: | :----: | ---- |
-| x86-64 | amd64-latest |
+| x86-64 | ✅ | amd64-\<version tag\> |
-| arm64 | arm64v8-latest |
+| arm64 | ✅ | arm64v8-\<version tag\> |
-| armhf | arm32v7-latest |
 
 ## Application Setup
 
-The default username is admin@admin.com with the password of **password**, access the container at http://dockerhost:6875.
+The default username is admin@admin.com with the password of **password**, access the container at http://<host ip>:6875.
 
-This application is dependent on a MySQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container here https://hub.docker.com/r/linuxserver/mariadb/.
+This application is dependent on a MariaDB database, be it one you already have or a new one. If you do not already have one, we provide an image here https://github.com/linuxserver/docker-mariadb.
 
+If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the `APP_URL` environment variable is set to your external domain, or it will not work.
 
-If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the `APP_URL` environment variable is set to your external domain, or it will not work
+Documentation for BookStack can be found at https://www.bookstackapp.com/docs/.
 
-Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
+### BookStack File & Directory Paths
+
+This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the `/config` folder so that they are persistent & accessible when the `/config` container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation.
+
+Below is a mapping of container `/config` paths to those relative within a BookStack install directory:
+
+- **/config container path** => **BookStack relative path**
+- `/config/www/.env` => `.env`
+- `/config/log/bookstack/laravel.log` => `storage/logs/laravel.log`
+- `/config/backups/` => `storage/backups/`
+- `/config/www/files/` => `storage/uploads/files/`
+- `/config/www/images/` => `storage/uploads/images/`
+- `/config/www/themes/` => `themes/`
+- `/config/www/uploads/` => `public/uploads/`
+
+### Changing APP_URL
+
+If you change the APP_URL after initial install, you should run the following line from your host terminal to update the database URL entries:
+
+```shell
+docker exec -it bookstack php /app/www/artisan bookstack:update-url ${OLD_URL} ${NEW_URL}
+```
 
 ### Advanced Users (full control over the .env file)
-If you wish to use the extra functionality of BookStack such as email, Memcache, LDAP and so on you will need to make your own .env file with guidance from the BookStack documentation.
-  
-When you create the container, do not set any arguments for any SQL settings. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
 
-#### PDF Rendering
+If you wish to use the extra functionality of BookStack such as email, LDAP and so on you will need to set additional environment variables or make your own .env file with guidance from the BookStack documentation.
-[wkhtmltopdf](https://wkhtmltopdf.org/) is available to use as an alternative PDF rendering generator as described at https://www.bookstackapp.com/docs/admin/pdf-rendering/.
 
-The path to wkhtmltopdf in this image to include in your .env file is `/usr/bin/wkhtmltopdf`.
+The container will copy an exemplary .env file to /config/www/.env on your host system for you to use.
+
+## Read-Only Operation
+
+This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/).
+
+### Caveats
+
+* `/tmp` must be mounted to tmpfs
 
 ## Usage
 
-Here are some example snippets to help you get started creating a container.
+To help you get started creating a container from this image you can either use docker-compose or the docker cli.
+
+>[!NOTE]
+>Unless a parameter is flagged as 'optional', it is *mandatory* and a value must be provided.
 
 ### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
 
 ```yaml
 ---
-version: "2"
 services:
   bookstack:
-    image: ghcr.io/linuxserver/bookstack
+    image: lscr.io/linuxserver/bookstack:latest
     container_name: bookstack
     environment:
       - PUID=1000
       - PGID=1000
+      - TZ=Etc/UTC
       - APP_URL=
-      - DB_HOST=bookstack_db
+      - APP_KEY=
-      - DB_USER=bookstack
+      - DB_HOST=
-      - DB_PASS=<yourdbpass>
+      - DB_PORT=3306
-      - DB_DATABASE=bookstackapp
+      - DB_USERNAME=
+      - DB_PASSWORD=
+      - DB_DATABASE=
+      - QUEUE_CONNECTION= #optional
     volumes:
-      - /path/to/data:/config
+      - /path/to/bookstack/config:/config
     ports:
       - 6875:80
     restart: unless-stopped
-    depends_on:
-      - bookstack_db
-  bookstack_db:
-    image: ghcr.io/linuxserver/mariadb
-    container_name: bookstack_db
-    environment:
-      - PUID=1000
-      - PGID=1000
-      - MYSQL_ROOT_PASSWORD=<yourdbpass>
-      - TZ=Europe/London
-      - MYSQL_DATABASE=bookstackapp
-      - MYSQL_USER=bookstack
-      - MYSQL_PASSWORD=<yourdbpass>
-    volumes:
-      - /path/to/data:/config
-    restart: unless-stopped
-
 ```
 
 ### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
@@ -133,32 +145,41 @@ docker run -d \
   --name=bookstack \
   -e PUID=1000 \
   -e PGID=1000 \
+  -e TZ=Etc/UTC \
   -e APP_URL= \
-  -e DB_HOST=<yourdbhost> \
+  -e APP_KEY= \
-  -e DB_USER=<yourdbuser> \
+  -e DB_HOST= \
-  -e DB_PASS=<yourdbpass> \
+  -e DB_PORT=3306 \
-  -e DB_DATABASE=bookstackapp \
+  -e DB_USERNAME= \
+  -e DB_PASSWORD= \
+  -e DB_DATABASE= \
+  -e QUEUE_CONNECTION= `#optional` \
   -p 6875:80 \
-  -v /path/to/data:/config \
+  -v /path/to/bookstack/config:/config \
   --restart unless-stopped \
-  ghcr.io/linuxserver/bookstack
+  lscr.io/linuxserver/bookstack:latest
 ```
 
 ## Parameters
 
-Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
+Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
 
 | Parameter | Function |
 | :----: | --- |
-| `-p 80` | will map the container's port 80 to port 6875 on the host |
+| `-p 6875:80` | http/s web interface. |
 | `-e PUID=1000` | for UserID - see below for explanation |
 | `-e PGID=1000` | for GroupID - see below for explanation |
-| `-e APP_URL=` | for specifying the IP:port or URL your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com` |
+| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
-| `-e DB_HOST=<yourdbhost>` | for specifying the database host |
+| `-e APP_URL=` | The protocol, IP/URL, and port that your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com` |
-| `-e DB_USER=<yourdbuser>` | for specifying the database user |
+| `-e APP_KEY=` | Session encryption key. You will need to generate this with `docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey` |
-| `-e DB_PASS=<yourdbpass>` | for specifying the database password |
+| `-e DB_HOST=` | The database instance hostname |
-| `-e DB_DATABASE=bookstackapp` | for specifying the database to be used |
+| `-e DB_PORT=3306` | Database port |
-| `-v /config` | this will store any uploaded data on the docker host |
+| `-e DB_USERNAME=` | Database user |
+| `-e DB_PASSWORD=` | Database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.) |
+| `-e DB_DATABASE=` | Database name |
+| `-e QUEUE_CONNECTION=` | Set to `database` to enable async actions like sending email or triggering webhooks. See [documentation](https://www.bookstackapp.com/docs/admin/email-webhooks/#async-action-handling). |
+| `-v /config` | Persistent config files |
+| `--read-only=true` | Run container with a read-only filesystem. Please [read the docs](https://docs.linuxserver.io/misc/read-only/). |
 
 ## Environment variables from files (Docker secrets)
 
@@ -167,10 +188,10 @@ You can set any environment variable from a file by using a special prepend `FIL
 As an example:
 
 ```bash
--e FILE__PASSWORD=/run/secrets/mysecretpassword
+-e FILE__MYVAR=/run/secrets/mysecretvariable
 ```
 
-Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
+Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
 
 ## Umask for running applications
 
@@ -179,15 +200,20 @@ Keep in mind umask is not chmod it subtracts from permissions based on it's valu
 
 ## User / Group Identifiers
 
-When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
+When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
 
 Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
 
-In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
+In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
 
 ```bash
-  $ id username
+id your_user
-    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
+```
+
+Example output:
+
+```text
+uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
 ```
 
 ## Docker Mods
@@ -198,53 +224,101 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
 
 ## Support Info
 
-* Shell access whilst the container is running: `docker exec -it bookstack /bin/bash`
+* Shell access whilst the container is running:
-* To monitor the logs of the container in realtime: `docker logs -f bookstack`
+
-* container version number
+    ```bash
-  * `docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack`
+    docker exec -it bookstack /bin/bash
-* image version number
+    ```
-  * `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/bookstack`
+
+* To monitor the logs of the container in realtime:
+
+    ```bash
+    docker logs -f bookstack
+    ```
+
+* Container version number:
+
+    ```bash
+    docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack
+    ```
+
+* Image version number:
+
+    ```bash
+    docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/bookstack:latest
+    ```
 
 ## Updating Info
 
-Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
+Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
 
 Below are the instructions for updating containers:
 
 ### Via Docker Compose
 
-* Update all images: `docker-compose pull`
+* Update images:
-  * or update a single image: `docker-compose pull bookstack`
+    * All images:
-* Let compose update all containers as necessary: `docker-compose up -d`
+
-  * or update a single container: `docker-compose up -d bookstack`
+        ```bash
-* You can also remove the old dangling images: `docker image prune`
+        docker-compose pull
+        ```
+
+    * Single image:
+
+        ```bash
+        docker-compose pull bookstack
+        ```
+
+* Update containers:
+    * All containers:
+
+        ```bash
+        docker-compose up -d
+        ```
+
+    * Single container:
+
+        ```bash
+        docker-compose up -d bookstack
+        ```
+
+* You can also remove the old dangling images:
+
+    ```bash
+    docker image prune
+    ```
 
 ### Via Docker Run
 
-* Update the image: `docker pull ghcr.io/linuxserver/bookstack`
+* Update the image:
-* Stop the running container: `docker stop bookstack`
+
-* Delete the container: `docker rm bookstack`
+    ```bash
+    docker pull lscr.io/linuxserver/bookstack:latest
+    ```
+
+* Stop the running container:
+
+    ```bash
+    docker stop bookstack
+    ```
+
+* Delete the container:
+
+    ```bash
+    docker rm bookstack
+    ```
+
 * Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
-* You can also remove the old dangling images: `docker image prune`
+* You can also remove the old dangling images:
 
-### Via Watchtower auto-updater (only use if you don't remember the original parameters)
+    ```bash
-
+    docker image prune
-* Pull the latest image at its tag and replace it with the same env variables in one run:
+    ```
-
-  ```bash
-  docker run --rm \
-  -v /var/run/docker.sock:/var/run/docker.sock \
-  containrrr/watchtower \
-  --run-once bookstack
-  ```
-
-* You can also remove the old dangling images: `docker image prune`
-
-**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
 
 ### Image Update Notifications - Diun (Docker Image Update Notifier)
 
-* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
+>[!TIP]
+>We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
 
 ## Building locally
 
@@ -256,19 +330,40 @@ cd docker-bookstack
 docker build \
   --no-cache \
   --pull \
-  -t ghcr.io/linuxserver/bookstack:latest .
+  -t lscr.io/linuxserver/bookstack:latest .
 ```
 
-The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
+The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
 
 ```bash
-docker run --rm --privileged multiarch/qemu-user-static:register --reset
+docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
 ```
 
 Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
 
 ## Versions
 
+* **28.12.25:** - Rebase to Alpine 3.23.
+* **05.07.25:** - Rebase to Alpine 3.22.
+* **04.01.25:** - Add php-opcache.
+* **17.12.24:** - Rebase to Alpine 3.21.
+* **11.10.24:** - Default to environment config over .env file config.
+* **06.09.24:** - Add php-exif for reading image EXIF data.
+* **27.05.24:** - Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings.
+* **25.01.24:** - Existing users should update: site-confs/default.conf - Cleanup default site conf.
+* **23.12.23:** - Rebase to Alpine 3.19 with php 8.3.
+* **31.10.23:** - Further sanitize sed replace.
+* **07.06.23:** - Add mariadb-client for bookstack-system-cli support.
+* **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf.
+* **13.04.23:** - Move ssl.conf include to default.conf.
+* **01.03.23:** - Add php iconv.
+* **19.01.23:** - Rebase to alpine 3.17 with php8.1.
+* **16.01.23:** - Wrap `.env` values in quotes.
+* **05.01.23:** - Fix db password setting (sed escape `&`).
+* **21.12.22:** - Update db info in .env file when env vars are updated.
+* **10.10.22:** - Remove password escape logic which caused problems for a small subset of users.
+* **20.08.22:** - Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base)).
+* **14.03.22:** - Add symlinks for theme support.
 * **11.07.21:** - Rebase to Alpine 3.14.
 * **12.01.21:** - Remove unused requirement, as of release 0.31.0.
 * **17.12.20:** - Make APP_URL var required (upstream changes).

jenkins-vars.yml

@@ -19,11 +19,11 @@ repo_vars:
   - PR_DOCKERHUB_IMAGE = 'lspipepr/bookstack'
   - DIST_IMAGE = 'alpine'
   - MULTIARCH = 'true'
-  - CI = 'true'
+  - CI = 'false'
   - CI_WEB = 'false'
   - CI_PORT = '80'
   - CI_SSL = 'false'
-  - CI_DELAY = '30'
+  - CI_DELAY = '60'
-  - CI_DOCKERENV='TEST_RUN=1'
+  - CI_DOCKERENV=''
-  - CI_AUTH = 'user:password'
+  - CI_AUTH = ''
   - CI_WEBPATH = ''

package_versions.txt

@@ -1,195 +1,296 @@
-alpine-baselayout-3.2.0-r15
+NAME                                VERSION                 TYPE           
-alpine-keys-2.3-r1
+Hidden Input                        1, 0, 0, 0              binary          
-alsa-lib-1.2.5-r2
+acl-libs                            2.3.2-r1                apk             
-apache2-utils-2.4.48-r0
+alpine-baselayout                   3.7.1-r8                apk             
-apk-tools-2.12.5-r1
+alpine-baselayout-data              3.7.1-r8                apk             
-apr-1.7.0-r0
+alpine-keys                         2.6-r0                  apk             
-apr-util-1.6.1-r7
+alpine-release                      3.23.3-r0               apk             
-argon2-libs-20190702-r1
+aom-libs                            3.13.1-r1               apk             
-avahi-libs-0.8-r4
+apache2-utils                       2.4.66-r0               apk             
-bash-5.1.4-r0
+apk-tools                           3.0.4-r0                apk             
-brotli-libs-1.0.9-r5
+apr                                 1.7.6-r0                apk             
-busybox-1.33.1-r3
+apr-util                            1.6.3-r2                apk             
-ca-certificates-20191127-r5
+argon2-libs                         20190702-r5             apk             
-ca-certificates-bundle-20191127-r5
+aws/aws-crt-php                     v1.2.7                  php-composer    
-cairo-1.16.0-r3
+aws/aws-sdk-php                     3.369.36                php-composer    
-cdparanoia-libs-10.2-r9
+bacon/bacon-qr-code                 v3.0.3                  php-composer    
-composer-2.1.3-r0
+bash                                5.3.3-r1                apk             
-coreutils-8.32-r2
+brick/math                          0.14.8                  php-composer    
-cups-libs-2.3.3-r2
+brotli-libs                         1.2.0-r0                apk             
-curl-7.77.0-r1
+busybox                             1.37.0-r30              apk             
-dbus-libs-1.12.20-r2
+busybox-binsh                       1.37.0-r30              apk             
-encodings-1.0.5-r0
+c-ares                              1.34.6-r0               apk             
-eudev-libs-3.2.10-r0
+ca-certificates                     20251003-r0             apk             
-expat-2.4.1-r0
+ca-certificates-bundle              20251003-r0             apk             
-fontconfig-2.13.1-r4
+carbonphp/carbon-doctrine-types     3.2.0                   php-composer    
-freetype-2.10.4-r1
+catatonit                           0.2.1-r0                apk             
-fribidi-1.0.10-r0
+composer                            2.9.5                   binary          
-gdbm-1.19-r0
+coreutils                           9.8-r1                  apk             
-git-2.32.0-r0
+coreutils-env                       9.8-r1                  apk             
-glib-2.68.2-r0
+coreutils-fmt                       9.8-r1                  apk             
-gmp-6.2.1-r0
+coreutils-sha512sum                 9.8-r1                  apk             
-gnutls-3.7.1-r0
+curl                                8.17.0-r1               apk             
-graphite2-1.3.14-r0
+dasprid/enum                        1.0.7                   php-composer    
-gst-plugins-base-1.18.4-r0
+dbus-libs                           1.16.2-r1               apk             
-gstreamer-1.18.4-r0
+dflydev/dot-access-data             v3.0.3                  php-composer    
-harfbuzz-2.8.1-r0
+doctrine/inflector                  2.1.0                   php-composer    
-hicolor-icon-theme-0.17-r1
+doctrine/lexer                      3.0.1                   php-composer    
-hyphen-2.8.8-r1
+dompdf/dompdf                       v3.1.4                  php-composer    
-icu-libs-67.1-r2
+dompdf/php-font-lib                 1.0.2                   php-composer    
-libacl-2.2.53-r0
+dompdf/php-svg-lib                  1.0.2                   php-composer    
-libattr-2.5.1-r0
+dragonmantank/cron-expression       v3.6.0                  php-composer    
-libblkid-2.37-r0
+egulias/email-validator             4.0.4                   php-composer    
-libbsd-0.11.3-r0
+encodings                           1.1.0-r0                apk             
-libbz2-1.0.8-r1
+ezyang/htmlpurifier                 v4.19.0                 php-composer    
-libc-utils-0.7.2-r3
+fakerphp/faker                      v1.24.1                 php-composer    
-libcap-2.50-r0
+filp/whoops                         2.18.4                  php-composer    
-libcrypto1.1-1.1.1k-r0
+findutils                           4.10.0-r0               apk             
-libcurl-7.77.0-r1
+firebase/php-jwt                    v7.0.2                  php-composer    
-libdrm-2.4.106-r0
+font-freefont                       20120503-r4             apk             
-libedit-20210216.3.1-r0
+fontconfig                          2.17.1-r0               apk             
-libevdev-1.11.0-r1
+freetype                            2.14.1-r0               apk             
-libevent-2.1.12-r2
+fruitcake/php-cors                  v1.4.0                  php-composer    
-libffi-3.3-r2
+gdbm                                1.26-r0                 apk             
-libfontenc-1.1.4-r0
+git                                 2.52.0-r0               apk             
-libgcc-10.3.1_git20210424-r2
+git-init-template                   2.52.0-r0               apk             
-libgcrypt-1.9.3-r0
+glib                                2.86.3-r0               apk             
-libgpg-error-1.42-r0
+graham-campbell/result-type         v1.1.4                  php-composer    
-libice-1.0.10-r0
+guzzlehttp/guzzle                   7.10.0                  php-composer    
-libinput-libs-1.18.0-r0
+guzzlehttp/promises                 2.3.0                   php-composer    
-libintl-0.21-r0
+guzzlehttp/psr7                     2.8.0                   php-composer    
-libjpeg-turbo-2.1.0-r0
+guzzlehttp/uri-template             v1.0.5                  php-composer    
-libldap-2.4.58-r0
+hamcrest/hamcrest-php               v2.1.1                  php-composer    
-libmagic-5.40-r1
+iamcal/sql-parser                   v0.7                    php-composer    
-libmd-1.0.3-r0
+icu-data-full                       76.1-r1                 apk             
-libmemcached-libs-1.0.18-r4
+icu-libs                            76.1-r1                 apk             
-libmount-2.37-r0
+intervention/gif                    4.2.4                   php-composer    
-libogg-1.3.5-r0
+intervention/image                  3.11.6                  php-composer    
-libpciaccess-0.16-r0
+itsgoingd/clockwork                 v5.3.5                  php-composer    
-libpcre2-16-10.36-r0
+jq                                  1.8.1-r0                apk             
-libpng-1.6.37-r1
+knplabs/knp-snappy                  v1.6.0                  php-composer    
-libproc-3.3.17-r0
+larastan/larastan                   v3.9.2                  php-composer    
-libressl3.3-libcrypto-3.3.3-r0
+laravel/framework                   v12.52.0                php-composer    
-libressl3.3-libssl-3.3.3-r0
+laravel/prompts                     v0.3.13                 php-composer    
-libretls-3.3.3-r2
+laravel/serializable-closure        v2.0.9                  php-composer    
-libsasl-2.1.27-r12
+laravel/socialite                   v5.24.2                 php-composer    
-libseccomp-2.5.1-r2
+laravel/tinker                      v2.11.1                 php-composer    
-libsm-1.2.3-r0
+league/commonmark                   2.8.0                   php-composer    
-libssl1.1-1.1.1k-r0
+league/config                       v1.2.0                  php-composer    
-libstdc++-10.3.1_git20210424-r2
+league/flysystem                    3.31.0                  php-composer    
-libtasn1-4.17.0-r0
+league/flysystem-aws-s3-v3          3.31.0                  php-composer    
-libtheora-1.1.1-r16
+league/flysystem-local              3.31.0                  php-composer    
-libunistring-0.9.10-r1
+league/html-to-markdown             5.1.1                   php-composer    
-libuuid-2.37-r0
+league/mime-type-detection          1.16.0                  php-composer    
-libvorbis-1.3.7-r0
+league/oauth1-client                v1.11.0                 php-composer    
-libwebp-1.2.0-r2
+league/oauth2-client                2.9.0                   php-composer    
-libx11-1.7.2-r0
+league/uri                          7.8.0                   php-composer    
-libxau-1.0.9-r0
+league/uri-interfaces               7.8.0                   php-composer    
-libxcb-1.14-r2
+libapk                              3.0.4-r0                apk             
-libxcomposite-0.4.5-r0
+libattr                             2.5.2-r2                apk             
-libxdmcp-1.1.3-r0
+libavif                             1.3.0-r0                apk             
-libxext-1.3.4-r0
+libblkid                            2.41.2-r0               apk             
-libxfixes-6.0.0-r0
+libbsd                              0.12.2-r0               apk             
-libxft-2.3.3-r0
+libbz2                              1.0.8-r6                apk             
-libxkbcommon-1.2.1-r0
+libcrypto3                          3.5.5-r0                apk             
-libxkbcommon-x11-1.2.1-r0
+libcurl                             8.17.0-r1               apk             
-libxml2-2.9.12-r1
+libdav1d                            1.5.2-r0                apk             
-libxpm-3.5.13-r0
+libeconf                            0.8.3-r0                apk             
-libxrender-0.9.10-r3
+libedit                             20251016.3.1-r0         apk             
-libxshmfence-1.3-r1
+libevent                            2.1.12-r8               apk             
-libxslt-1.1.34-r1
+libexpat                            2.7.4-r0                apk             
-libxt-1.2.1-r0
+libffi                              3.5.2-r0                apk             
-libxv-1.0.11-r2
+libfontenc                          1.1.8-r0                apk             
-libxxf86vm-1.1.4-r2
+libgcc                              15.2.0-r2               apk             
-libzip-1.7.3-r2
+libice                              1.1.2-r0                apk             
-linux-pam-1.5.1-r1
+libidn2                             2.3.8-r0                apk             
-logrotate-3.18.1-r0
+libintl                             0.24.1-r1               apk             
-memcached-1.6.9-r0
+libjpeg-turbo                       3.1.2-r0                apk             
-mesa-21.1.2-r0
+libldap                             2.6.10-r0               apk             
-mesa-egl-21.1.2-r0
+libmd                               1.1.0-r0                apk             
-mesa-gbm-21.1.2-r0
+libmemcached-libs                   1.1.4-r1                apk             
-mesa-gl-21.1.2-r0
+libmount                            2.41.2-r0               apk             
-mesa-glapi-21.1.2-r0
+libncursesw                         6.5_p20251123-r0        apk             
-mkfontscale-1.2.1-r1
+libpcre2-16                         10.47-r0                apk             
-mtdev-1.1.6-r0
+libpng                              1.6.54-r0               apk             
-musl-1.2.2-r3
+libproc2                            4.0.5-r0                apk             
-musl-utils-1.2.2-r3
+libpsl                              0.21.5-r3               apk             
-nano-5.7-r2
+libsasl                             2.1.28-r9               apk             
-ncurses-libs-6.2_p20210612-r0
+libseccomp                          2.6.0-r1                apk             
-ncurses-terminfo-base-6.2_p20210612-r0
+libsharpyuv                         1.6.0-r0                apk             
-netcat-openbsd-1.130-r2
+libsm                               1.2.6-r0                apk             
-nettle-3.7.2-r0
+libssl3                             3.5.5-r0                apk             
-nghttp2-libs-1.43.0-r0
+libstdc++                           15.2.0-r2               apk             
-nginx-1.20.1-r3
+libunistring                        1.4.1-r0                apk             
-oniguruma-6.9.7.1-r0
+libuuid                             2.41.2-r0               apk             
-openssl-1.1.1k-r0
+libwebp                             1.6.0-r0                apk             
-opus-1.3.1-r1
+libx11                              1.8.12-r1               apk             
-orc-0.4.32-r0
+libxau                              1.0.12-r0               apk             
-p11-kit-0.23.22-r0
+libxcb                              1.17.0-r1               apk             
-pango-1.48.5-r0
+libxdmcp                            1.1.5-r1                apk             
-pcre-8.44-r0
+libxext                             1.3.6-r2                apk             
-pcre2-10.36-r0
+libxml2                             2.13.9-r0               apk             
-php7-7.4.21-r0
+libxpm                              3.5.17-r0               apk             
-php7-common-7.4.21-r0
+libxt                               1.3.1-r0                apk             
-php7-ctype-7.4.21-r0
+libyuv                              0.0.1887.20251502-r1    apk             
-php7-curl-7.4.21-r0
+libzip                              1.11.4-r1               apk             
-php7-dom-7.4.21-r0
+linux-pam                           1.7.1-r2                apk             
-php7-fileinfo-7.4.21-r0
+logrotate                           3.22.0-r0               apk             
-php7-fpm-7.4.21-r0
+mariadb-client                      11.4.9-r0               apk             
-php7-gd-7.4.21-r0
+mariadb-common                      11.4.9-r0               apk             
-php7-iconv-7.4.21-r0
+masterminds/html5                   2.10.0                  php-composer    
-php7-json-7.4.21-r0
+memcached                           1.6.39-r0               apk             
-php7-ldap-7.4.21-r0
+mkfontscale                         1.2.3-r1                apk             
-php7-mbstring-7.4.21-r0
+mockery/mockery                     1.6.12                  php-composer    
-php7-mysqlnd-7.4.21-r0
+monolog/monolog                     3.10.0                  php-composer    
-php7-openssl-7.4.21-r0
+mtdowling/jmespath.php              2.8.0                   php-composer    
-php7-pdo-7.4.21-r0
+musl                                1.2.5-r21               apk             
-php7-pdo_mysql-7.4.21-r0
+musl-utils                          1.2.5-r21               apk             
-php7-pecl-igbinary-3.2.3-r0
+myclabs/deep-copy                   1.13.4                  php-composer    
-php7-pecl-memcached-3.1.5-r2
+nano                                8.7-r0                  apk             
-php7-phar-7.4.21-r0
+ncurses-terminfo-base               6.5_p20251123-r0        apk             
-php7-session-7.4.21-r0
+nesbot/carbon                       3.11.1                  php-composer    
-php7-simplexml-7.4.21-r0
+netcat-openbsd                      1.234.1-r0              apk             
-php7-tokenizer-7.4.21-r0
+nette/schema                        v1.3.4                  php-composer    
-php7-xml-7.4.21-r0
+nette/utils                         v4.1.3                  php-composer    
-php7-xmlwriter-7.4.21-r0
+nghttp2-libs                        1.68.0-r0               apk             
-php7-zip-7.4.21-r0
+nghttp3                             1.13.1-r0               apk             
-pixman-0.40.0-r2
+nginx                               1.28.2-r0               apk             
-pkgconf-1.7.4-r0
+nikic/php-parser                    v5.7.0                  php-composer    
-popt-1.18-r0
+nunomaduro/collision                v8.9.1                  php-composer    
-procps-3.3.17-r0
+nunomaduro/termwind                 v2.4.0                  php-composer    
-qt5-qtbase-5.15.3_git20210406-r0
+onelogin/php-saml                   4.3.1                   php-composer    
-qt5-qtbase-x11-5.15.3_git20210406-r0
+oniguruma                           6.9.10-r0               apk             
-qt5-qtdeclarative-5.15.3_git20210531-r0
+openssl                             3.5.5-r0                apk             
-qt5-qtlocation-5.15.3_git20201109-r0
+paragonie/constant_time_encoding    v3.1.3                  php-composer    
-qt5-qtsensors-5.15.3_git20201028-r1
+paragonie/random_compat             v9.99.100               php-composer    
-qt5-qtsvg-5.15.3_git20200406-r0
+pcre2                               10.47-r0                apk             
-qt5-qtwayland-5.15.3_git20210510-r0
+phar-io/manifest                    2.0.4                   php-composer    
-qt5-qtwebchannel-5.15.3_git20201028-r0
+phar-io/version                     3.2.1                   php-composer    
-qt5-qtwebkit-5.212.0_alpha4-r14
+php85                               8.5.2-r0                apk             
-readline-8.1.0-r0
+php85-common                        8.5.2-r0                apk             
-s6-ipcserver-2.10.0.3-r0
+php85-ctype                         8.5.2-r0                apk             
-scanelf-1.3.2-r0
+php85-curl                          8.5.2-r0                apk             
-shadow-4.8.1-r0
+php85-dom                           8.5.2-r0                apk             
-skalibs-2.10.0.3-r0
+php85-exif                          8.5.2-r0                apk             
-sqlite-libs-3.35.5-r0
+php85-fileinfo                      8.5.2-r0                apk             
-ssl_client-1.33.1-r3
+php85-fpm                           8.5.2-r0                apk             
-tar-1.34-r0
+php85-gd                            8.5.2-r0                apk             
-ttf-freefont-20120503-r1
+php85-iconv                         8.5.2-r0                apk             
-tzdata-2021a-r0
+php85-ldap                          8.5.2-r0                apk             
-utmps-0.1.0.2-r0
+php85-mbstring                      8.5.2-r0                apk             
-wayland-libs-client-1.19.0-r0
+php85-mysqlnd                       8.5.2-r0                apk             
-wayland-libs-cursor-1.19.0-r0
+php85-openssl                       8.5.2-r0                apk             
-wayland-libs-egl-1.19.0-r0
+php85-pdo                           8.5.2-r0                apk             
-wayland-libs-server-1.19.0-r0
+php85-pdo_mysql                     8.5.2-r0                apk             
-wkhtmltopdf-0.12.6-r0
+php85-pecl-igbinary                 3.2.17_rc1-r0           apk             
-xcb-util-0.4.0-r3
+php85-pecl-memcached                3.4.0-r0                apk             
-xcb-util-image-0.4.0-r1
+php85-pecl-msgpack                  3.0.0-r0                apk             
-xcb-util-keysyms-0.4.0-r1
+php85-phar                          8.5.2-r0                apk             
-xcb-util-renderutil-0.3.9-r1
+php85-session                       8.5.2-r0                apk             
-xcb-util-wm-0.4.1-r1
+php85-simplexml                     8.5.2-r0                apk             
-xkeyboard-config-2.33-r0
+php85-sockets                       8.5.2-r0                apk             
-xz-5.2.5-r0
+php85-tokenizer                     8.5.2-r0                apk             
-xz-libs-5.2.5-r0
+php85-xml                           8.5.2-r0                apk             
-zlib-1.2.11-r3
+php85-xmlwriter                     8.5.2-r0                apk             
-zstd-libs-1.4.9-r1
+php85-zip                           8.5.2-r0                apk             
+phpoption/phpoption                 1.9.5                   php-composer    
+phpseclib/phpseclib                 3.0.49                  php-composer    
+phpstan/phpstan                     2.1.39                  php-composer    
+phpunit/php-code-coverage           11.0.12                 php-composer    
+phpunit/php-file-iterator           5.1.1                   php-composer    
+phpunit/php-invoker                 5.0.1                   php-composer    
+phpunit/php-text-template           4.0.1                   php-composer    
+phpunit/php-timer                   7.0.1                   php-composer    
+phpunit/phpunit                     11.5.55                 php-composer    
+popt                                1.19-r4                 apk             
+pragmarx/google2fa                  v9.0.0                  php-composer    
+predis/predis                       v3.4.0                  php-composer    
+procps-ng                           4.0.5-r0                apk             
+psr/clock                           1.0.0                   php-composer    
+psr/container                       2.0.2                   php-composer    
+psr/event-dispatcher                1.0.0                   php-composer    
+psr/http-client                     1.0.3                   php-composer    
+psr/http-factory                    1.1.0                   php-composer    
+psr/http-message                    2.0                     php-composer    
+psr/log                             3.0.2                   php-composer    
+psr/simple-cache                    3.0.0                   php-composer    
+psy/psysh                           v0.12.20                php-composer    
+qt5-qtbase                          5.15.10_git20230714-r4  apk             
+ralouphie/getallheaders             3.0.3                   php-composer    
+ramsey/collection                   2.1.1                   php-composer    
+ramsey/uuid                         4.9.2                   php-composer    
+readline                            8.3.1-r0                apk             
+robrichards/xmlseclibs              3.1.4                   php-composer    
+sabberworm/php-css-parser           v9.1.0                  php-composer    
+scanelf                             1.3.8-r2                apk             
+sebastian/cli-parser                3.0.2                   php-composer    
+sebastian/code-unit                 3.0.3                   php-composer    
+sebastian/code-unit-reverse-lookup  4.0.1                   php-composer    
+sebastian/comparator                6.3.3                   php-composer    
+sebastian/complexity                4.0.1                   php-composer    
+sebastian/diff                      6.0.2                   php-composer    
+sebastian/environment               7.2.1                   php-composer    
+sebastian/exporter                  6.3.2                   php-composer    
+sebastian/global-state              7.0.2                   php-composer    
+sebastian/lines-of-code             3.0.1                   php-composer    
+sebastian/object-enumerator         6.0.1                   php-composer    
+sebastian/object-reflector          4.0.1                   php-composer    
+sebastian/recursion-context         6.0.3                   php-composer    
+sebastian/type                      5.1.3                   php-composer    
+sebastian/version                   5.0.2                   php-composer    
+shadow                              4.18.0-r0               apk             
+skalibs-libs                        2.14.4.0-r0             apk             
+socialiteproviders/discord          4.2.0                   php-composer    
+socialiteproviders/gitlab           4.1.0                   php-composer    
+socialiteproviders/manager          v4.8.1                  php-composer    
+socialiteproviders/microsoft-azure  5.2.0                   php-composer    
+socialiteproviders/okta             4.5.0                   php-composer    
+socialiteproviders/twitch           5.4.0                   php-composer    
+squizlabs/php_codesniffer           4.0.1                   php-composer    
+ssddanbrown/asserthtml              v3.1.0                  php-composer    
+ssddanbrown/htmldiff                v2.0.0                  php-composer    
+ssl_client                          1.37.0-r30              apk             
+staabm/side-effects-detector        1.0.5                   php-composer    
+symfony/clock                       v7.4.0                  php-composer    
+symfony/console                     v7.4.4                  php-composer    
+symfony/css-selector                v7.4.0                  php-composer    
+symfony/deprecation-contracts       v3.6.0                  php-composer    
+symfony/dom-crawler                 v7.4.4                  php-composer    
+symfony/error-handler               v7.4.4                  php-composer    
+symfony/event-dispatcher            v7.4.4                  php-composer    
+symfony/event-dispatcher-contracts  v3.6.0                  php-composer    
+symfony/filesystem                  v7.4.0                  php-composer    
+symfony/finder                      v7.4.5                  php-composer    
+symfony/http-foundation             v7.4.5                  php-composer    
+symfony/http-kernel                 v7.4.5                  php-composer    
+symfony/mailer                      v7.4.4                  php-composer    
+symfony/mime                        v7.4.5                  php-composer    
+symfony/polyfill-ctype              v1.33.0                 php-composer    
+symfony/polyfill-intl-grapheme      v1.33.0                 php-composer    
+symfony/polyfill-intl-idn           v1.33.0                 php-composer    
+symfony/polyfill-intl-normalizer    v1.33.0                 php-composer    
+symfony/polyfill-mbstring           v1.33.0                 php-composer    
+symfony/polyfill-php80              v1.33.0                 php-composer    
+symfony/polyfill-php83              v1.33.0                 php-composer    
+symfony/polyfill-php84              v1.33.0                 php-composer    
+symfony/polyfill-php85              v1.33.0                 php-composer    
+symfony/polyfill-uuid               v1.33.0                 php-composer    
+symfony/process                     v7.4.5                  php-composer    
+symfony/routing                     v7.4.4                  php-composer    
+symfony/service-contracts           v3.6.1                  php-composer    
+symfony/string                      v7.4.4                  php-composer    
+symfony/translation                 v7.4.4                  php-composer    
+symfony/translation-contracts       v3.6.1                  php-composer    
+symfony/uid                         v7.4.4                  php-composer    
+symfony/var-dumper                  v7.4.4                  php-composer    
+thecodingmachine/safe               v3.4.0                  php-composer    
+theseer/tokenizer                   1.3.1                   php-composer    
+tijsverkoyen/css-to-inline-styles   v2.4.0                  php-composer    
+tzdata                              2025c-r0                apk             
+utmps-libs                          0.1.3.1-r0              apk             
+vlucas/phpdotenv                    v5.6.3                  php-composer    
+voku/portable-ascii                 2.0.3                   php-composer    
+xemlock/htmlpurifier-html5          v0.1.12                 php-composer    
+xz-libs                             5.8.2-r0                apk             
+zlib                                1.3.1-r2                apk             
+zstd-libs                           1.5.7-r2                apk             

readme-vars.yml

@@ -3,117 +3,173 @@
 # project information
 project_name: bookstack
 project_url: "https://github.com/BookStackApp/BookStack"
-project_logo: "https://s3-us-west-2.amazonaws.com/linuxserver-docs/images/bookstack-logo500x500.png"
+project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/bookstack-logo.png"
 project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
+project_categories: "Content Management"
 project_blurb: |
-  [{{ project_name|capitalize }}]({{ project_url }}) is a free and open source Wiki designed for creating beautiful documentation. Feautring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
+  [{{ project_name|capitalize }}]({{ project_url }}) is a free and open source Wiki designed for creating beautiful documentation. Featuring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
 
   Powered by SQL and including a Markdown editor for those who prefer it, BookStack is geared towards making documentation more of a pleasure than a chore.
 
   For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
-
 # supported architectures
 available_architectures:
-  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
+  - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
-  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
+  - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
-  - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}
-
 # container parameters
 param_container_name: "{{ project_name }}"
 param_usage_include_vols: true
 param_volumes:
-  - { vol_path: "/config", vol_host_path: "/path/to/data", desc: "this will store any uploaded data on the docker host" }
+  - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files"}
 param_usage_include_env: true
 param_env_vars:
-  - { env_var: "APP_URL", env_value: "", desc: "for specifying the IP:port or URL your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com`"}
+  - {env_var: "APP_URL", env_value: "", desc: "The protocol, IP/URL, and port that your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com`"}
-  - { env_var: "DB_HOST", env_value: "<yourdbhost>", desc: "for specifying the database host" }
+  - {env_var: "APP_KEY", env_value: "", desc: "Session encryption key. You will need to generate this with `docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey`"}
-  - { env_var: "DB_USER", env_value: "<yourdbuser>", desc: "for specifying the database user" }
+  - {env_var: "DB_HOST", env_value: "", desc: "The database instance hostname"}
-  - { env_var: "DB_PASS", env_value: "<yourdbpass>", desc: "for specifying the database password" }
+  - {env_var: "DB_PORT", env_value: "3306", desc: "Database port"}
-  - { env_var: "DB_DATABASE", env_value: "bookstackapp", desc: "for specifying the database to be used" }
+  - {env_var: "DB_USERNAME", env_value: "", desc: "Database user"}
-
+  - {env_var: "DB_PASSWORD", env_value: "", desc: "Database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.)"}
+  - {env_var: "DB_DATABASE", env_value: "", desc: "Database name"}
 param_usage_include_ports: true
 param_ports:
-  - { external_port: "6875", internal_port: "80", port_desc: "will map the container's port 80 to port 6875 on the host" }
+  - {external_port: "6875", internal_port: "80", port_desc: "http/s web interface."}
-
+opt_param_usage_include_env: true
-opt_param_usage_include_env: false
 opt_param_env_vars:
-
+  - {env_var: "QUEUE_CONNECTION", env_value: "", desc: "Set to `database` to enable async actions like sending email or triggering webhooks. See [documentation](https://www.bookstackapp.com/docs/admin/email-webhooks/#async-action-handling)."}
-custom_compose: |
+readonly_supported: true
-  ---
+readonly_message: |
-  version: "2"
+  * `/tmp` must be mounted to tmpfs
-  services:
-    bookstack:
-      image: ghcr.io/linuxserver/bookstack
-      container_name: bookstack
-      environment:
-        - PUID=1000
-        - PGID=1000
-        - APP_URL=
-        - DB_HOST=bookstack_db
-        - DB_USER=bookstack
-        - DB_PASS=<yourdbpass>
-        - DB_DATABASE=bookstackapp
-      volumes:
-        - /path/to/data:/config
-      ports:
-        - 6875:80
-      restart: unless-stopped
-      depends_on:
-        - bookstack_db
-    bookstack_db:
-      image: ghcr.io/linuxserver/mariadb
-      container_name: bookstack_db
-      environment:
-        - PUID=1000
-        - PGID=1000
-        - MYSQL_ROOT_PASSWORD=<yourdbpass>
-        - TZ=Europe/London
-        - MYSQL_DATABASE=bookstackapp
-        - MYSQL_USER=bookstack
-        - MYSQL_PASSWORD=<yourdbpass>
-      volumes:
-        - /path/to/data:/config
-      restart: unless-stopped
-
 # application setup block
 app_setup_block_enabled: true
 app_setup_block: |
+  The default username is admin@admin.com with the password of **password**, access the container at http://<host ip>:6875.
 
-  The default username is admin@admin.com with the password of **password**, access the container at http://dockerhost:6875.
+  This application is dependent on a MariaDB database, be it one you already have or a new one. If you do not already have one, we provide an image here https://github.com/linuxserver/docker-mariadb.
 
-  This application is dependent on a MySQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container here https://hub.docker.com/r/linuxserver/mariadb/.
+  If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the `APP_URL` environment variable is set to your external domain, or it will not work.
 
-  
+  Documentation for BookStack can be found at https://www.bookstackapp.com/docs/.
-  If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the `APP_URL` environment variable is set to your external domain, or it will not work
 
-  Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
+  ### BookStack File & Directory Paths
+
+  This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the `/config` folder so that they are persistent & accessible when the `/config` container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation.
+
+  Below is a mapping of container `/config` paths to those relative within a BookStack install directory:
+
+  - **/config container path** => **BookStack relative path**
+  - `/config/www/.env` => `.env`
+  - `/config/log/bookstack/laravel.log` => `storage/logs/laravel.log`
+  - `/config/backups/` => `storage/backups/`
+  - `/config/www/files/` => `storage/uploads/files/`
+  - `/config/www/images/` => `storage/uploads/images/`
+  - `/config/www/themes/` => `themes/`
+  - `/config/www/uploads/` => `public/uploads/`
+
+  ### Changing APP_URL
+
+  If you change the APP_URL after initial install, you should run the following line from your host terminal to update the database URL entries:
+
+  ```shell
+  docker exec -it bookstack php /app/www/artisan bookstack:update-url ${OLD_URL} ${NEW_URL}
+  ```
 
   ### Advanced Users (full control over the .env file)
-  If you wish to use the extra functionality of BookStack such as email, Memcache, LDAP and so on you will need to make your own .env file with guidance from the BookStack documentation.
-    
-  When you create the container, do not set any arguments for any SQL settings. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
-  
-  #### PDF Rendering
-  [wkhtmltopdf](https://wkhtmltopdf.org/) is available to use as an alternative PDF rendering generator as described at https://www.bookstackapp.com/docs/admin/pdf-rendering/.
-  
-  The path to wkhtmltopdf in this image to include in your .env file is `/usr/bin/wkhtmltopdf`.
 
+  If you wish to use the extra functionality of BookStack such as email, LDAP and so on you will need to set additional environment variables or make your own .env file with guidance from the BookStack documentation.
 
+  The container will copy an exemplary .env file to /config/www/.env on your host system for you to use.
+# init diagram
+init_diagram: |
+  "bookstack:latest": {
+    docker-mods
+    base {
+      fix-attr +\nlegacy cont-init
+    }
+    docker-mods -> base
+    legacy-services
+    custom services
+    init-services -> legacy-services
+    init-services -> custom services
+    custom services -> legacy-services
+    legacy-services -> ci-service-check
+    init-migrations -> init-adduser
+    init-nginx-end -> init-bookstack-config
+    init-nginx-end -> init-config
+    init-os-end -> init-config
+    init-bookstack-config -> init-config-end
+    init-config -> init-config-end
+    init-crontab-config -> init-config-end
+    init-config -> init-crontab-config
+    init-mods-end -> init-custom-files
+    init-adduser -> init-device-perms
+    base -> init-envfile
+    init-os-end -> init-folders
+    init-php -> init-keygen
+    base -> init-migrations
+    init-config-end -> init-mods
+    init-mods-package-install -> init-mods-end
+    init-mods -> init-mods-package-install
+    init-samples -> init-nginx
+    init-version-checks -> init-nginx-end
+    init-adduser -> init-os-end
+    init-device-perms -> init-os-end
+    init-envfile -> init-os-end
+    init-keygen -> init-permissions
+    init-nginx -> init-php
+    init-folders -> init-samples
+    init-custom-files -> init-services
+    init-permissions -> init-version-checks
+    init-services -> svc-cron
+    svc-cron -> legacy-services
+    init-services -> svc-memcached
+    svc-memcached -> legacy-services
+    init-services -> svc-nginx
+    svc-nginx -> legacy-services
+    init-services -> svc-php-fpm
+    svc-php-fpm -> legacy-services
+    init-services -> svc-queue-worker
+    svc-queue-worker -> legacy-services
+  }
+  Base Images: {
+    "baseimage-alpine-nginx:3.23" <- "baseimage-alpine:3.23"
+  }
+  "bookstack:latest" <- Base Images
 # changelog
 changelogs:
-  - { date: "11.07.21:", desc: "Rebase to Alpine 3.14." }
+  - {date: "28.12.25:", desc: "Rebase to Alpine 3.23."}
-  - { date: "12.01.21:", desc: "Remove unused requirement, as of release 0.31.0." }
+  - {date: "05.07.25:", desc: "Rebase to Alpine 3.22."}
-  - { date: "17.12.20:", desc: "Make APP_URL var required (upstream changes)." }
+  - {date: "04.01.25:", desc: "Add php-opcache."}
-  - { date: "17.09.20:", desc: "Rebase to alpine 3.12. Fix APP_URL setting. Bump php post max and upload max filesizes to 100MB by default." }
+  - {date: "17.12.24:", desc: "Rebase to Alpine 3.21."}
-  - { date: "19.12.19:", desc: "Rebasing to alpine 3.11." }
+  - {date: "11.10.24:", desc: "Default to environment config over .env file config."}
-  - { date: "26.07.19:", desc: "Use old version of tidyhtml pending upstream fixes." }
+  - {date: "06.09.24:", desc: "Add php-exif for reading image EXIF data."}
-  - { date: "28.06.19:", desc: "Rebasing to alpine 3.10." }
+  - {date: "27.05.24:", desc: "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings."}
-  - { date: "14.06.19:", desc: "Add wkhtmltopdf to image for PDF rendering." }
+  - {date: "25.01.24:", desc: "Existing users should update: site-confs/default.conf - Cleanup default site conf."}
-  - { date: "20.04.19:", desc: "Rebase to Alpine 3.9, add MySQL init logic." }
+  - {date: "23.12.23:", desc: "Rebase to Alpine 3.19 with php 8.3."}
-  - { date: "22.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
+  - {date: "31.10.23:", desc: "Further sanitize sed replace."}
-  - { date: "20.01.19:", desc: "Added php7-curl"}
+  - {date: "07.06.23:", desc: "Add mariadb-client for bookstack-system-cli support."}
-  - { date: "04.11.18:", desc: "Added php7-ldap"}
+  - {date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf."}
-  - { date: "15.10.18:", desc: "Changed functionality for advanced users"}
+  - {date: "13.04.23:", desc: "Move ssl.conf include to default.conf."}
-  - { date: "08.10.18:", desc: "Advanced mode, symlink changes, sed fixing, docs updated, added some composer files"}
+  - {date: "01.03.23:", desc: "Add php iconv."}
-  - { date: "23.09.28:", desc: "Updates pre-release"}
+  - {date: "19.01.23:", desc: "Rebase to alpine 3.17 with php8.1."}
-  - { date: "02.07.18:", desc: "Initial Release." }
+  - {date: "16.01.23:", desc: "Wrap `.env` values in quotes."}
+  - {date: "05.01.23:", desc: "Fix db password setting (sed escape `&`)."}
+  - {date: "21.12.22:", desc: "Update db info in .env file when env vars are updated."}
+  - {date: "10.10.22:", desc: "Remove password escape logic which caused problems for a small subset of users."}
+  - {date: "20.08.22:", desc: "Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base))."}
+  - {date: "14.03.22:", desc: "Add symlinks for theme support."}
+  - {date: "11.07.21:", desc: "Rebase to Alpine 3.14."}
+  - {date: "12.01.21:", desc: "Remove unused requirement, as of release 0.31.0."}
+  - {date: "17.12.20:", desc: "Make APP_URL var required (upstream changes)."}
+  - {date: "17.09.20:", desc: "Rebase to alpine 3.12. Fix APP_URL setting. Bump php post max and upload max filesizes to 100MB by default."}
+  - {date: "19.12.19:", desc: "Rebasing to alpine 3.11."}
+  - {date: "26.07.19:", desc: "Use old version of tidyhtml pending upstream fixes."}
+  - {date: "28.06.19:", desc: "Rebasing to alpine 3.10."}
+  - {date: "14.06.19:", desc: "Add wkhtmltopdf to image for PDF rendering."}
+  - {date: "20.04.19:", desc: "Rebase to Alpine 3.9, add MySQL init logic."}
+  - {date: "22.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag."}
+  - {date: "20.01.19:", desc: "Added php7-curl"}
+  - {date: "04.11.18:", desc: "Added php7-ldap"}
+  - {date: "15.10.18:", desc: "Changed functionality for advanced users"}
+  - {date: "08.10.18:", desc: "Advanced mode, symlink changes, sed fixing, docs updated, added some composer files"}
+  - {date: "23.09.28:", desc: "Updates pre-release"}
+  - {date: "02.07.18:", desc: "Initial Release."}

root/appkey

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+mkdir -p \
+    /config/www/framework/{cache,sessions,views} \
+    /config/log/bookstack
+
+touch /config/log/bookstack/laravel.log
+
+php /app/www/artisan key:generate --show --no-ansi

root/defaults/default

@@ -1,39 +0,0 @@
-## Version 2018/03/06 - Changelog: https://github.com/linuxserver/docker-heimdall/commits/master/root/defaults/default
-
-server {
-	listen 80 default_server;
-
-	listen 443 ssl;
-
-	root /var/www/html/public;
-	index index.php index.html index.htm;
-
-	server_name _;
-
-	ssl_certificate /config/keys/cert.crt;
-	ssl_certificate_key /config/keys/cert.key;
-
-	client_max_body_size 0;
-
-        error_page 599 = @noauth;
-
-        location @noauth {
-                try_files $uri $uri/ /index.php?$args;
-        }
-
-	location / {
-		try_files $uri $uri/ /index.php?$query_string;
-
-	}
-
-	location ~ \.php$ {
-		fastcgi_split_path_info ^(.+\.php)(/.+)$;
-		# With php5-cgi alone:
-		fastcgi_pass 127.0.0.1:9000;
-		# With php5-fpm:
-		#fastcgi_pass unix:/var/run/php5-fpm.sock;
-		fastcgi_index index.php;
-		include /etc/nginx/fastcgi_params;
-
-	}
-}

root/defaults/nginx.conf

@@ -1,98 +0,0 @@
-user abc;
-worker_processes 4;
-pid /run/nginx.pid;
-include /etc/nginx/modules/*.conf;
-
-events {
-	worker_connections 768;
-	# multi_accept on;
-}
-
-http {
-
-	##
-	# Basic Settings
-	##
-
-	sendfile on;
-	tcp_nopush on;
-	tcp_nodelay on;
-	keepalive_timeout 65;
-	types_hash_max_size 2048;
-	# server_tokens off;
-
-	# server_names_hash_bucket_size 64;
-	# server_name_in_redirect off;
-
-	client_max_body_size 0;
-
-	include /etc/nginx/mime.types;
-	default_type application/octet-stream;
-
-	##
-	# Logging Settings
-	##
-
-	access_log /config/log/nginx/access.log;
-	error_log /config/log/nginx/error.log;
-
-	##
-	# Gzip Settings
-	##
-
-	gzip on;
-	gzip_disable "msie6";
-
-	# gzip_vary on;
-	# gzip_proxied any;
-	# gzip_comp_level 6;
-	# gzip_buffers 16 8k;
-	# gzip_http_version 1.1;
-	# gzip_types text/plain text/css application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript;
-
-	##
-	# nginx-naxsi config
-	##
-	# Uncomment it if you installed nginx-naxsi
-	##
-
-	#include /etc/nginx/naxsi_core.rules;
-
-	##
-	# nginx-passenger config
-	##
-	# Uncomment it if you installed nginx-passenger
-	##
-
-	#passenger_root /usr;
-	#passenger_ruby /usr/bin/ruby;
-
-	##
-	# Virtual Host Configs
-	##
-	include /etc/nginx/conf.d/*.conf;
-	include /config/nginx/site-confs/*;
-}
-
-
-#mail {
-#	# See sample authentication script at:
-#	# http://wiki.nginx.org/ImapAuthenticateWithApachePhpScript
-#
-#	# auth_http localhost/auth.php;
-#	# pop3_capabilities "TOP" "USER";
-#	# imap_capabilities "IMAP4rev1" "UIDPLUS";
-#
-#	server {
-#		listen     localhost:110;
-#		protocol   pop3;
-#		proxy      on;
-#	}
-#
-#	server {
-#		listen     localhost:143;
-#		protocol   imap;
-#		proxy      on;
-#	}
-#}
-daemon off;

root/etc/cont-init.d/50-config

@@ -1,115 +0,0 @@
-#!/usr/bin/with-contenv bash
-
-# create directory structure
-mkdir -p \
-	/config/www/{uploads,files,images}
-
-# check for .env and copy default if needed
-[[ ! -f "/config/www/.env" ]] && \
-	cp /var/www/html/.env.example /config/www/.env
-
-# check for zero-length .env and alert user if found
-[[ ! -s "/config/www/.env" ]] && \
-  echo "WARNING: zero-length .env file detected. Please delete /config/www/.env and restart the container"
-
-# create symlinks
-symlinks=( \
-/var/www/html/storage/uploads/files \
-/var/www/html/storage/uploads/images \
-/var/www/html/public/uploads \
-/var/www/html/.env \
-/var/www/html/storage/logs/laravel.log
-)
-
-for i in "${symlinks[@]}"
-do
-[[ -e "$i" && ! -L "$i" ]] && rm -rf "$i"
-[[ ! -L "$i" ]] && ln -s /config/www/"$(basename "$i")" "$i"
-done
-
-# Echo init finish for test runs
-if [ -n "${TEST_RUN}" ]; then
-	echo '[services.d] done.'
-fi
-
-# Create API key if needed
-if [ ! -f "/config/BOOKSTACK_APP_KEY.txt" ];
-	then
-	echo "Generating BookStack app key for first run"
-	key=$(php /var/www/html/artisan key:generate --show)
-	echo $key > /config/BOOKSTACK_APP_KEY.txt
-	echo "App Key set to $key you can modify the file to update /config/BOOKSTACK_APP_KEY.txt"
-elif [ -f "/config/BOOKSTACK_APP_KEY.txt" ];
-	then
-	echo "App Key found - setting variable for seds"
-	key=$(cat /config/BOOKSTACK_APP_KEY.txt)
-fi
-
-# .env file setup
-# check for the default app key or if it has been updated
-if grep -Fxq "APP_KEY=SomeRandomString" /config/www/.env || \
-! grep -Fxq "APP_KEY=${key}" /config/www/.env; then
-	sed -i "s#^APP_KEY=.*#APP_KEY=${key}#" /config/www/.env
-fi
-# check to see if db_user is set, if it is then run seds and if not then leave them
-if [ "${DB_USER}" ];
-	then
-	echo "Running config - db_user set"
-	ESCAPED_PASSWORD=$(sed -e 's/[$\/&]/\\&/g' <<< $DB_PASS)
-	sed -i "s/DB_HOST=localhost/DB_HOST=${DB_HOST}/g" /config/www/.env
-	sed -i "s/DB_DATABASE=database_database/DB_DATABASE=${DB_DATABASE}/g" /config/www/.env
-	sed -i "s/DB_USERNAME=database_username/DB_USERNAME=${DB_USER}/g" /config/www/.env
-	sed -i "s/DB_PASSWORD=database_user_password/DB_PASSWORD=${ESCAPED_PASSWORD}/g" /config/www/.env
-fi
-
-# set appurl
-if [ -z "${APP_URL}" ]; then
-	EXT_IP=$(curl -s https://icanhazip.com)
-	APP_URL="http://${EXT_IP}:6875"
-	echo "**** Docker env var APP_URL is not set, setting it to ${APP_URL} ****"
-fi
-OLD_URL=$(grep APP_URL /config/www/.env | sed 's|.*APP_URL=||g')
-if [ "${APP_URL}" != "${OLD_URL}" ]; then
-	sed -r "s,([#\s]*)?APP_URL=.*,APP_URL=${APP_URL},g" -i /config/www/.env
-	echo "**** APP_URL in /config/www/.env is being updated from ${OLD_URL} to ${APP_URL} ****"
-	if [ "${OLD_URL}" != "http://example.com" ]; then
-		echo "**** If this is an existing install, you should run the following line from your host terminal to update the database URL entries: ****"
-		echo "************************************************************************"
-		echo "docker exec -it bookstack php /var/www/html/artisan bookstack:update-url ${OLD_URL} ${APP_URL}"
-		echo "************************************************************************"
-	fi
-fi
-
-## Bump php upload max filesize and post max size to 100MB by default
-grep -qx '^upload_max_filesize.*$' /config/php/php-local.ini || echo 'upload_max_filesize = 100M' >> /config/php/php-local.ini
-grep -qx '^post_max_size.*$' /config/php/php-local.ini || echo 'post_max_size = 100M' >> /config/php/php-local.ini
-
-# check for the mysql endpoint for 30 seconds
-END=$((SECONDS+30))
-while [ ${SECONDS} -lt ${END} ] && [ -n "${DB_HOST+x}" ]; do
-	/usr/bin/nc -z ${DB_HOST} 3306 && \
-	if [ ! -z "$(/usr/bin/nc -w1 ${DB_HOST} 3306)" ]; then
-		[ ! -z "${RUN}" ] && break
-		RUN="RAN"
-		# we sleep here again due to first run init on DB containers
-		[ ! -f /dbwait.lock ] && sleep 5
-	else
-		sleep 1
-	fi
-	sleep 1
-done
-
-# update database - will set up database if fresh, or, migrate existing
-if [ -z "${CI_RUN+x}" ]; then
-	php /var/www/html/artisan migrate --force
-fi
-
-# set permissions
-chown -R abc:abc \
-	/config
-
-find /var/www -print0 | xargs -P "$(nproc)" -I {} -0 chown -h abc:abc {}
-find /var/www -print0 -type d | xargs -P "$(nproc)" -I {} -0 chown -h abc:abc {}
-
-# set lockfile to avoid DB waits for this specific container
-touch /dbwait.lock

root/etc/s6-overlay/s6-rc.d/init-bookstack-config/run

@@ -0,0 +1,63 @@
+#!/usr/bin/with-contenv bash
+# shellcheck shell=bash
+
+# create directory structure
+mkdir -p \
+    /config/www/{uploads,files,images,themes} \
+    /config/www/framework/{cache,sessions,views,purifier} \
+    /config/backups \
+    /config/log/bookstack
+
+if [[ ! -f /tmp/dbwait.lock ]];then
+    rm -rf /config/www/framework/{cache,sessions,views,purifier}/*
+fi
+
+# check for .env and copy default if needed
+if [[ ! -f "/config/www/.env" ]] || [[ ! -s "/config/www/.env" ]]; then
+    cp /app/www/.env.example /config/www/.env
+fi
+
+# Check for app key
+if [[ -z ${APP_KEY} ]]; then
+    if ! grep -qE "APP_KEY=[0-9A-Za-z:+\/=]{1,}" /config/www/.env 2> /dev/null || grep -qE "APP_KEY=SomeRandomString" /config/www/.env 2> /dev/null; then
+        echo "The application key is missing, halting init!"
+        echo "You can generate a key with: docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey"
+        echo "And apply it to the APP_KEY environment variable."
+        sleep infinity
+    fi
+fi
+
+## Bump php upload max filesize and post max size to 100MB by default
+if ! grep -qx '^upload_max_filesize.*$' /config/php/php-local.ini; then
+    echo 'upload_max_filesize = 100M' >>/config/php/php-local.ini
+fi
+if ! grep -qx '^post_max_size.*$' /config/php/php-local.ini; then
+    echo 'post_max_size = 100M' >>/config/php/php-local.ini
+fi
+
+# if DB_PORT is not set
+if [[ -z "${DB_PORT}" ]]; then
+    DB_PORT="3306"
+fi
+
+# check for the mysql endpoint
+echo "Waiting for DB to be available"
+END=$((SECONDS + 30))
+while [[ ${SECONDS} -lt ${END} ]] && [[ -n "${DB_HOST+x}" ]]; do
+    if [[ $(/usr/bin/nc -w1 "${DB_HOST}" "${DB_PORT}" | tr -d '\0') ]]; then
+        if [[ ! -f /tmp/dbwait.lock ]]; then
+            sleep 5
+        fi
+        touch /tmp/dbwait.lock
+        break
+    else
+        sleep 1
+    fi
+done
+
+# update database - will set up database if fresh, or, migrate existing
+php /app/www/artisan migrate --force
+
+# permissions
+lsiown -R abc:abc \
+    /config

root/etc/s6-overlay/s6-rc.d/init-bookstack-config/type

@@ -0,0 +1 @@
+oneshot

root/etc/s6-overlay/s6-rc.d/init-bookstack-config/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-bookstack-config/run

root/etc/s6-overlay/s6-rc.d/svc-memcached/run

@@ -1,2 +1,4 @@
 #!/usr/bin/with-contenv bash
+# shellcheck shell=bash
+
 exec memcached -u abc

root/etc/s6-overlay/s6-rc.d/svc-memcached/type

@@ -0,0 +1 @@
+longrun

root/etc/s6-overlay/s6-rc.d/svc-queue-worker/run

@@ -0,0 +1,6 @@
+#!/usr/bin/with-contenv bash
+# shellcheck shell=bash
+
+echo "*** Starting Async Action Queue ***"
+
+exec /usr/bin/php /app/www/artisan queue:work --sleep=3 --tries=1 --max-time=3600

root/etc/s6-overlay/s6-rc.d/svc-queue-worker/type

@@ -0,0 +1 @@
+longrun

root/etc/services.d/php-fpm/run

@@ -1,2 +0,0 @@
-#!/usr/bin/with-contenv bash
-exec /usr/sbin/php-fpm7 -F

root/init-hook

@@ -0,0 +1,9 @@
+#!/usr/bin/with-contenv bash
+# shellcheck shell=bash
+
+if [[ -n "${QUEUE_CONNECTION}" ]]; then
+    touch /etc/s6-overlay/s6-rc.d/user/contents.d/svc-queue-worker
+fi
+
+exec \
+    /docker-mods

root/migrations/02-default-location

@@ -0,0 +1,11 @@
+#!/usr/bin/with-contenv bash
+# shellcheck shell=bash
+
+DEFAULT_CONF="/config/nginx/site-confs/default.conf"
+OLD_ROOT="root /var/www/html/public;"
+NEW_ROOT="root /app/www/public;"
+
+if [[ -f "${DEFAULT_CONF}" ]] && grep -q "${OLD_ROOT}" "${DEFAULT_CONF}" 2>/dev/null; then
+    echo "updating root in ${DEFAULT_CONF}"
+    sed -i "s|${OLD_ROOT}|${NEW_ROOT}|" "${DEFAULT_CONF}"
+fi

root/var/www/html/public/index.html

@@ -0,0 +1,40 @@
+<html>
+    <head>
+        <title>Upgrade Required!</title>
+        <style>
+        body{
+            font-family: Helvetica, Arial, sans-serif;
+        }
+        .message{
+            width:440px;
+            padding:20px 40px;
+            margin:0 auto;
+            background-color:#f9f9f9;
+            border:1px solid #ddd;
+            color: #1e3d62;
+        }
+        center{
+            margin:40px 0;
+        }
+        h1{
+            font-size: 18px;
+            line-height: 26px;
+        }
+        p{
+            font-size: 12px;
+        }
+        a{
+            color: rgb(207, 48, 139);
+        }
+        </style>
+    </head>
+    <body>
+        <div class="message">
+            <h1>Upgrade Required!</h1>
+            <p>The application inside this image has been moved to a new folder.</p>
+            <p>You will need to update your <strong>/config/nginx/nginx.conf</strong> and <strong>/config/nginx/site-confs/default.conf</strong> in order for the application to work.</p>
+            <p>New config samples are located at <strong>/config/nginx/nginx.conf.sample</strong> and <strong>/config/nginx/site-confs/default.conf.sample</strong></p>
+            <p>Please review our announcement: <a target="_blank" href="https://info.linuxserver.io/issues/2022-08-20-nginx-base/">Significant changes to nginx based images</a></p>
+        </div>
+    </body>
+</html>