mirror of
https://github.com/linuxserver/docker-bookstack.git
synced 2026-02-20 02:30:30 +08:00
Compare commits
No commits in common. "master" and "v24.02-ls134" have entirely different histories.
master
...
v24.02-ls1
0
.editorconfig
Normal file → Executable file
0
.editorconfig
Normal file → Executable file
6
.github/CONTRIBUTING.md
vendored
Normal file → Executable file
6
.github/CONTRIBUTING.md
vendored
Normal file → Executable file
@ -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://linuxserver.io/discord)
|
||||
* 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)
|
||||
|
||||
## Common files
|
||||
|
||||
@ -105,10 +105,10 @@ docker build \
|
||||
-t linuxserver/bookstack:latest .
|
||||
```
|
||||
|
||||
The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
|
||||
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
|
||||
|
||||
```bash
|
||||
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
|
||||
docker run --rm --privileged multiarch/qemu-user-static:register --reset
|
||||
```
|
||||
|
||||
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
|
||||
|
||||
0
.github/FUNDING.yml
vendored
Normal file → Executable file
0
.github/FUNDING.yml
vendored
Normal file → Executable file
2
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file → Executable file
2
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file → Executable file
@ -1,7 +1,7 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Discord chat support
|
||||
url: https://linuxserver.io/discord
|
||||
url: https://discord.gg/YWrKVTn
|
||||
about: Realtime support / chat with the community and the team.
|
||||
|
||||
- name: Discourse discussion forum
|
||||
|
||||
0
.github/ISSUE_TEMPLATE/issue.bug.yml
vendored
Normal file → Executable file
0
.github/ISSUE_TEMPLATE/issue.bug.yml
vendored
Normal file → Executable file
0
.github/ISSUE_TEMPLATE/issue.feature.yml
vendored
Normal file → Executable file
0
.github/ISSUE_TEMPLATE/issue.feature.yml
vendored
Normal file → Executable file
3
.github/workflows/call_issue_pr_tracker.yml
vendored
Normal file → Executable file
3
.github/workflows/call_issue_pr_tracker.yml
vendored
Normal file → Executable file
@ -8,9 +8,6 @@ on:
|
||||
pull_request_review:
|
||||
types: [submitted,edited,dismissed]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
manage-project:
|
||||
permissions:
|
||||
|
||||
3
.github/workflows/call_issues_cron.yml
vendored
Normal file → Executable file
3
.github/workflows/call_issues_cron.yml
vendored
Normal file → Executable file
@ -4,9 +4,6 @@ on:
|
||||
- cron: '3 9 * * *'
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
stale:
|
||||
permissions:
|
||||
|
||||
143
.github/workflows/external_trigger.yml
vendored
Normal file → Executable file
143
.github/workflows/external_trigger.yml
vendored
Normal file → Executable file
@ -3,9 +3,6 @@ name: External Trigger Main
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
external-trigger-master:
|
||||
runs-on: ubuntu-latest
|
||||
@ -14,31 +11,18 @@ jobs:
|
||||
|
||||
- name: External Trigger
|
||||
if: github.ref == 'refs/heads/master'
|
||||
env:
|
||||
SKIP_EXTERNAL_TRIGGER: ${{ vars.SKIP_EXTERNAL_TRIGGER }}
|
||||
run: |
|
||||
printf "# External trigger for docker-bookstack\n\n" >> $GITHUB_STEP_SUMMARY
|
||||
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
|
||||
if [ -n "${{ secrets.PAUSE_EXTERNAL_TRIGGER_BOOKSTACK_MASTER }}" ]; then
|
||||
echo "**** Github secret PAUSE_EXTERNAL_TRIGGER_BOOKSTACK_MASTER is set; skipping trigger. ****"
|
||||
echo "Github secret \`PAUSE_EXTERNAL_TRIGGER_BOOKSTACK_MASTER\` is set; skipping trigger." >> $GITHUB_STEP_SUMMARY
|
||||
exit 0
|
||||
fi
|
||||
echo "> [!NOTE]" >> $GITHUB_STEP_SUMMARY
|
||||
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
|
||||
echo "**** External trigger running off of master branch. To disable this trigger, set a Github secret named \"PAUSE_EXTERNAL_TRIGGER_BOOKSTACK_MASTER\". ****"
|
||||
echo "External trigger running off of master branch. To disable this trigger, set a Github secret named \`PAUSE_EXTERNAL_TRIGGER_BOOKSTACK_MASTER\`" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**** Retrieving external version ****"
|
||||
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 "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
|
||||
echo "> Can't retrieve external version, exiting" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**** Can't retrieve external version, exiting ****"
|
||||
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,
|
||||
@ -46,43 +30,25 @@ jobs:
|
||||
"username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
|
||||
exit 1
|
||||
fi
|
||||
EXT_RELEASE_SANITIZED=$(echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g')
|
||||
echo "Sanitized external version: \`${EXT_RELEASE_SANITIZED}\`" >> $GITHUB_STEP_SUMMARY
|
||||
echo "Retrieving last pushed version" >> $GITHUB_STEP_SUMMARY
|
||||
EXT_RELEASE=$(echo ${EXT_RELEASE} | sed 's/[~,%@+;:/]//g')
|
||||
echo "**** External version: ${EXT_RELEASE} ****"
|
||||
echo "External version: ${EXT_RELEASE}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**** Retrieving last pushed version ****"
|
||||
image="linuxserver/bookstack"
|
||||
tag="latest"
|
||||
token=$(curl -sX GET \
|
||||
"https://ghcr.io/token?scope=repository%3Alinuxserver%2Fbookstack%3Apull" \
|
||||
| jq -r '.token')
|
||||
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 \
|
||||
multidigest=$(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/${multidigest}"); then
|
||||
digest=$(jq -r '.config.digest' <<< "${digest}");
|
||||
fi
|
||||
fi
|
||||
"https://ghcr.io/v2/${image}/manifests/${tag}" \
|
||||
| jq -r 'first(.manifests[].digest)')
|
||||
digest=$(curl -s \
|
||||
--header "Accept: application/vnd.docker.distribution.manifest.v2+json" \
|
||||
--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}")
|
||||
@ -94,54 +60,45 @@ jobs:
|
||||
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 "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
|
||||
echo "Can't retrieve last pushed version, exiting" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**** Can't retrieve last pushed version, exiting ****"
|
||||
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}\`" >> $GITHUB_STEP_SUMMARY
|
||||
if [ "${EXT_RELEASE_SANITIZED}" == "${IMAGE_VERSION}" ]; then
|
||||
echo "Sanitized version \`${EXT_RELEASE_SANITIZED}\` already pushed, exiting" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**** Last pushed version: ${IMAGE_VERSION} ****"
|
||||
echo "Last pushed version: ${IMAGE_VERSION}" >> $GITHUB_STEP_SUMMARY
|
||||
if [ "${EXT_RELEASE}" == "${IMAGE_VERSION}" ]; then
|
||||
echo "**** Version ${EXT_RELEASE} already pushed, exiting ****"
|
||||
echo "Version ${EXT_RELEASE} 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" >> $GITHUB_STEP_SUMMARY
|
||||
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
|
||||
if [[ "${artifacts_found}" == "false" ]]; then
|
||||
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
|
||||
echo "> New version detected, but not all artifacts are published yet; skipping trigger" >> $GITHUB_STEP_SUMMARY
|
||||
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."
|
||||
curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903,
|
||||
"description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}],
|
||||
"username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
|
||||
else
|
||||
printf "\n## Trigger new build\n\n" >> $GITHUB_STEP_SUMMARY
|
||||
echo "New sanitized version \`${EXT_RELEASE_SANITIZED}\` found; old version was \`${IMAGE_VERSION}\`. Triggering new build" >> $GITHUB_STEP_SUMMARY
|
||||
if [[ "${artifacts_found}" == "true" ]]; then
|
||||
echo "All artifacts seem to be uploaded." >> $GITHUB_STEP_SUMMARY
|
||||
fi
|
||||
response=$(curl -iX POST \
|
||||
https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/buildWithParameters?PACKAGE_CHECK=false \
|
||||
--user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|")
|
||||
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
|
||||
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
|
||||
echo "**** New version ${EXT_RELEASE} found; old version was ${IMAGE_VERSION}. Triggering new build ****"
|
||||
echo "New version ${EXT_RELEASE} found; old version was ${IMAGE_VERSION}. Triggering new build" >> $GITHUB_STEP_SUMMARY
|
||||
response=$(curl -iX POST \
|
||||
https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/buildWithParameters?PACKAGE_CHECK=false \
|
||||
--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 "Jenkins job build url: ${buildurl}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**** Attempting to change the Jenkins job description ****"
|
||||
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}"
|
||||
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
|
||||
|
||||
27
.github/workflows/external_trigger_scheduler.yml
vendored
Normal file → Executable file
27
.github/workflows/external_trigger_scheduler.yml
vendored
Normal file → Executable file
@ -5,9 +5,6 @@ on:
|
||||
- cron: '19 * * * *'
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
external-trigger-scheduler:
|
||||
runs-on: ubuntu-latest
|
||||
@ -18,31 +15,31 @@ jobs:
|
||||
|
||||
- name: External Trigger Scheduler
|
||||
run: |
|
||||
printf "# External trigger scheduler for docker-bookstack\n\n" >> $GITHUB_STEP_SUMMARY
|
||||
printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY
|
||||
for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes)
|
||||
echo "**** Branches found: ****"
|
||||
git for-each-ref --format='%(refname:short)' refs/remotes
|
||||
for br in $(git for-each-ref --format='%(refname:short)' refs/remotes)
|
||||
do
|
||||
if [[ "${br}" == "HEAD" ]]; then
|
||||
printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY
|
||||
continue
|
||||
fi
|
||||
printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY
|
||||
br=$(echo "$br" | sed 's|origin/||g')
|
||||
echo "**** Evaluating branch ${br} ****"
|
||||
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
|
||||
echo "**** Branch ${br} appears to be live and trigger is not os; checking workflow. ****"
|
||||
if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then
|
||||
echo "Triggering external trigger workflow for branch." >> $GITHUB_STEP_SUMMARY
|
||||
echo "**** Workflow exists. Triggering external trigger workflow for branch ${br} ****."
|
||||
echo "Triggering external trigger workflow for branch ${br}" >> $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 "Skipping branch due to no external trigger workflow present." >> $GITHUB_STEP_SUMMARY
|
||||
echo "**** Workflow doesn't exist; skipping trigger. ****"
|
||||
echo "Skipping branch ${br} due to no external trigger workflow present." >> $GITHUB_STEP_SUMMARY
|
||||
fi
|
||||
else
|
||||
echo "Skipping branch due to being detected as dev branch or having no external version." >> $GITHUB_STEP_SUMMARY
|
||||
echo "**** ${br} is either a dev branch, or has no external version; skipping trigger. ****"
|
||||
echo "Skipping branch ${br} due to being detected as dev branch or having no external version." >> $GITHUB_STEP_SUMMARY
|
||||
fi
|
||||
done
|
||||
|
||||
6
.github/workflows/greetings.yml
vendored
Normal file → Executable file
6
.github/workflows/greetings.yml
vendored
Normal file → Executable file
@ -2,14 +2,8 @@ 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
|
||||
|
||||
42
.github/workflows/package_trigger.yml
vendored
Executable file
42
.github/workflows/package_trigger.yml
vendored
Executable file
@ -0,0 +1,42 @@
|
||||
name: Package Trigger Main
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
package-trigger-master:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4.1.1
|
||||
|
||||
- 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. ****"
|
||||
echo "Github secret \`PAUSE_PACKAGE_TRIGGER_BOOKSTACK_MASTER\` is set; skipping trigger." >> $GITHUB_STEP_SUMMARY
|
||||
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 ****"
|
||||
echo "There already seems to be an active build on Jenkins; skipping package trigger" >> $GITHUB_STEP_SUMMARY
|
||||
exit 0
|
||||
fi
|
||||
echo "**** Package trigger running off of master branch. To disable, set a Github secret named \"PAUSE_PACKAGE_TRIGGER_BOOKSTACK_MASTER\". ****"
|
||||
echo "Package trigger running off of master branch. To disable, set a Github secret named \`PAUSE_PACKAGE_TRIGGER_BOOKSTACK_MASTER\`" >> $GITHUB_STEP_SUMMARY
|
||||
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 "Jenkins job build url: ${buildurl}" >> $GITHUB_STEP_SUMMARY
|
||||
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"
|
||||
105
.github/workflows/package_trigger_scheduler.yml
vendored
Normal file → Executable file
105
.github/workflows/package_trigger_scheduler.yml
vendored
Normal file → Executable file
@ -5,9 +5,6 @@ on:
|
||||
- cron: '4 18 * * 1'
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
package-trigger-scheduler:
|
||||
runs-on: ubuntu-latest
|
||||
@ -17,87 +14,37 @@ jobs:
|
||||
fetch-depth: '0'
|
||||
|
||||
- name: Package Trigger Scheduler
|
||||
env:
|
||||
SKIP_PACKAGE_TRIGGER: ${{ vars.SKIP_PACKAGE_TRIGGER }}
|
||||
run: |
|
||||
printf "# Package trigger scheduler for docker-bookstack\n\n" >> $GITHUB_STEP_SUMMARY
|
||||
printf "Found the branches:\n\n%s\n" "$(git for-each-ref --format='- %(refname:lstrip=3)' refs/remotes)" >> $GITHUB_STEP_SUMMARY
|
||||
for br in $(git for-each-ref --format='%(refname:lstrip=3)' refs/remotes)
|
||||
echo "**** Branches found: ****"
|
||||
git for-each-ref --format='%(refname:short)' refs/remotes
|
||||
for br in $(git for-each-ref --format='%(refname:short)' refs/remotes)
|
||||
do
|
||||
if [[ "${br}" == "HEAD" ]]; then
|
||||
printf "\nSkipping %s.\n" ${br} >> $GITHUB_STEP_SUMMARY
|
||||
continue
|
||||
fi
|
||||
printf "\n## Evaluating \`%s\`\n\n" ${br} >> $GITHUB_STEP_SUMMARY
|
||||
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}/Jenkinsfile >/dev/null 2>&1; then
|
||||
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
|
||||
echo "> No Jenkinsfile found. Branch is either deprecated or is an early dev branch." >> $GITHUB_STEP_SUMMARY
|
||||
skipped_branches="${skipped_branches}${br} "
|
||||
elif [[ "${br}" == $(yq -r '.ls_branch' <<< "${JENKINS_VARS}") ]]; then
|
||||
echo "Branch appears to be live; checking workflow." >> $GITHUB_STEP_SUMMARY
|
||||
README_VARS=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/readme-vars.yml)
|
||||
if [[ $(yq -r '.project_deprecation_status' <<< "${README_VARS}") == "true" ]]; then
|
||||
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 "> [!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
|
||||
br=$(echo "$br" | sed 's|origin/||g')
|
||||
echo "**** Evaluating branch ${br} ****"
|
||||
ls_branch=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/jenkins-vars.yml | yq -r '.ls_branch')
|
||||
if [ "${br}" == "${ls_branch}" ]; then
|
||||
echo "**** Branch ${br} appears to be live; checking workflow. ****"
|
||||
if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/.github/workflows/package_trigger.yml > /dev/null 2>&1; then
|
||||
echo "**** Workflow exists. Triggering package trigger workflow for branch ${br}. ****"
|
||||
echo "Triggering package trigger workflow for branch ${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
|
||||
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/package_trigger.yml/dispatches
|
||||
sleep 30
|
||||
else
|
||||
echo "**** Workflow doesn't exist; skipping trigger. ****"
|
||||
echo "Skipping branch ${br} due to no package trigger workflow present." >> $GITHUB_STEP_SUMMARY
|
||||
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
|
||||
if [[ -n "${triggered_branches}" ]] || [[ -n "${skipped_branches}" ]]; then
|
||||
if [[ -n "${triggered_branches}" ]]; then
|
||||
NOTIFY_BRANCHES="**Triggered:** ${triggered_branches} \n"
|
||||
NOTIFY_BUILD_URL="**Build URL:** https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-bookstack/activity/ \n"
|
||||
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
|
||||
echo "**** Package check build(s) triggered for branch(es): ${triggered_branches} ****"
|
||||
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) 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"}],
|
||||
"username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
|
||||
|
||||
2
.github/workflows/permissions.yml
vendored
Normal file → Executable file
2
.github/workflows/permissions.yml
vendored
Normal file → Executable file
@ -5,8 +5,6 @@ on:
|
||||
- '**/run'
|
||||
- '**/finish'
|
||||
- '**/check'
|
||||
- 'root/migrations/*'
|
||||
|
||||
jobs:
|
||||
permission_check:
|
||||
uses: linuxserver/github-workflows/.github/workflows/init-svc-executable-permissions.yml@v1
|
||||
|
||||
31
Dockerfile
31
Dockerfile
@ -1,13 +1,13 @@
|
||||
# syntax=docker/dockerfile:1
|
||||
|
||||
FROM ghcr.io/linuxserver/baseimage-alpine-nginx:3.23
|
||||
FROM ghcr.io/linuxserver/baseimage-alpine-nginx:3.19
|
||||
|
||||
# set version label
|
||||
ARG BUILD_DATE
|
||||
ARG VERSION
|
||||
ARG BOOKSTACK_RELEASE
|
||||
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
|
||||
LABEL maintainer="thespad"
|
||||
LABEL maintainer="homerr"
|
||||
|
||||
ENV S6_STAGE2_HOOK="/init-hook"
|
||||
|
||||
@ -17,20 +17,19 @@ RUN \
|
||||
fontconfig \
|
||||
mariadb-client \
|
||||
memcached \
|
||||
php85-dom \
|
||||
php85-exif \
|
||||
php85-gd \
|
||||
php85-ldap \
|
||||
php85-mysqlnd \
|
||||
php85-pdo_mysql \
|
||||
php85-pecl-memcached \
|
||||
php85-tokenizer \
|
||||
php83-dom \
|
||||
php83-gd \
|
||||
php83-ldap \
|
||||
php83-mysqlnd \
|
||||
php83-pdo_mysql \
|
||||
php83-pecl-memcached \
|
||||
php83-tokenizer \
|
||||
qt5-qtbase \
|
||||
ttf-freefont && \
|
||||
echo "**** configure php-fpm to pass env vars ****" && \
|
||||
sed -E -i 's/^;?clear_env ?=.*$/clear_env = no/g' /etc/php85/php-fpm.d/www.conf && \
|
||||
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 && \
|
||||
echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php85/php-fpm.conf && \
|
||||
sed -E -i 's/^;?clear_env ?=.*$/clear_env = no/g' /etc/php83/php-fpm.d/www.conf && \
|
||||
grep -qxF 'clear_env = no' /etc/php83/php-fpm.d/www.conf || echo 'clear_env = no' >> /etc/php83/php-fpm.d/www.conf && \
|
||||
echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php83/php-fpm.conf && \
|
||||
echo "**** fetch bookstack ****" && \
|
||||
mkdir -p\
|
||||
/app/www && \
|
||||
@ -46,12 +45,6 @@ RUN \
|
||||
/app/www/ --strip-components=1 && \
|
||||
echo "**** install composer dependencies ****" && \
|
||||
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 \
|
||||
/tmp/* \
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
# syntax=docker/dockerfile:1
|
||||
|
||||
FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm64v8-3.23
|
||||
FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm64v8-3.19
|
||||
|
||||
# set version label
|
||||
ARG BUILD_DATE
|
||||
ARG VERSION
|
||||
ARG BOOKSTACK_RELEASE
|
||||
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
|
||||
LABEL maintainer="thespad"
|
||||
LABEL maintainer="homerr"
|
||||
|
||||
ENV S6_STAGE2_HOOK="/init-hook"
|
||||
|
||||
@ -17,20 +17,19 @@ RUN \
|
||||
fontconfig \
|
||||
mariadb-client \
|
||||
memcached \
|
||||
php85-dom \
|
||||
php85-exif \
|
||||
php85-gd \
|
||||
php85-ldap \
|
||||
php85-mysqlnd \
|
||||
php85-pdo_mysql \
|
||||
php85-pecl-memcached \
|
||||
php85-tokenizer \
|
||||
php83-dom \
|
||||
php83-gd \
|
||||
php83-ldap \
|
||||
php83-mysqlnd \
|
||||
php83-pdo_mysql \
|
||||
php83-pecl-memcached \
|
||||
php83-tokenizer \
|
||||
qt5-qtbase \
|
||||
ttf-freefont && \
|
||||
echo "**** configure php-fpm to pass env vars ****" && \
|
||||
sed -E -i 's/^;?clear_env ?=.*$/clear_env = no/g' /etc/php85/php-fpm.d/www.conf && \
|
||||
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 && \
|
||||
echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php85/php-fpm.conf && \
|
||||
sed -E -i 's/^;?clear_env ?=.*$/clear_env = no/g' /etc/php83/php-fpm.d/www.conf && \
|
||||
grep -qxF 'clear_env = no' /etc/php83/php-fpm.d/www.conf || echo 'clear_env = no' >> /etc/php83/php-fpm.d/www.conf && \
|
||||
echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php83/php-fpm.conf && \
|
||||
echo "**** fetch bookstack ****" && \
|
||||
mkdir -p\
|
||||
/app/www && \
|
||||
@ -46,12 +45,6 @@ RUN \
|
||||
/app/www/ --strip-components=1 && \
|
||||
echo "**** install composer dependencies ****" && \
|
||||
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 \
|
||||
/tmp/* \
|
||||
|
||||
608
Jenkinsfile
vendored
608
Jenkinsfile
vendored
@ -8,7 +8,7 @@ pipeline {
|
||||
}
|
||||
// Input to determine if this is a package check
|
||||
parameters {
|
||||
string(defaultValue: 'false', description: 'package check run', name: 'PACKAGE_CHECK')
|
||||
string(defaultValue: 'false', description: 'package check run', name: 'PACKAGE_CHECK')
|
||||
}
|
||||
// Configuration for the variables used for this specific repo
|
||||
environment {
|
||||
@ -17,8 +17,6 @@ pipeline {
|
||||
GITLAB_TOKEN=credentials('b6f0f1dd-6952-4cf6-95d1-9c06380283f0')
|
||||
GITLAB_NAMESPACE=credentials('gitlab-namespace-id')
|
||||
DOCKERHUB_TOKEN=credentials('docker-hub-ci-pat')
|
||||
QUAYIO_API_TOKEN=credentials('quayio-repo-api-token')
|
||||
GIT_SIGNING_KEY=credentials('484fbca6-9a4f-455e-b9e3-97ac98785f5f')
|
||||
EXT_GIT_BRANCH = 'master'
|
||||
EXT_USER = 'bookstackapp'
|
||||
EXT_REPO = 'bookstack'
|
||||
@ -31,51 +29,25 @@ pipeline {
|
||||
PR_DOCKERHUB_IMAGE = 'lspipepr/bookstack'
|
||||
DIST_IMAGE = 'alpine'
|
||||
MULTIARCH = 'true'
|
||||
CI = 'false'
|
||||
CI = 'true'
|
||||
CI_WEB = 'false'
|
||||
CI_PORT = '80'
|
||||
CI_SSL = 'false'
|
||||
CI_DELAY = '60'
|
||||
CI_DOCKERENV=''
|
||||
CI_AUTH = ''
|
||||
CI_DELAY = '30'
|
||||
CI_DOCKERENV='TEST_RUN=1'
|
||||
CI_AUTH = 'user:password'
|
||||
CI_WEBPATH = ''
|
||||
}
|
||||
stages {
|
||||
stage("Set git config"){
|
||||
steps{
|
||||
sh '''#!/bin/bash
|
||||
cat ${GIT_SIGNING_KEY} > /config/.ssh/id_sign
|
||||
chmod 600 /config/.ssh/id_sign
|
||||
ssh-keygen -y -f /config/.ssh/id_sign > /config/.ssh/id_sign.pub
|
||||
echo "Using $(ssh-keygen -lf /config/.ssh/id_sign) to sign commits"
|
||||
git config --global gpg.format ssh
|
||||
git config --global user.signingkey /config/.ssh/id_sign
|
||||
git config --global commit.gpgsign true
|
||||
'''
|
||||
}
|
||||
}
|
||||
// Setup all the basic environment variables needed for the build
|
||||
stage("Set ENV Variables base"){
|
||||
steps{
|
||||
echo "Running on node: ${NODE_NAME}"
|
||||
sh '''#! /bin/bash
|
||||
echo "Pruning builder"
|
||||
docker builder prune -f --builder container || :
|
||||
containers=$(docker ps -q)
|
||||
containers=$(docker ps -aq)
|
||||
if [[ -n "${containers}" ]]; then
|
||||
BUILDX_CONTAINER_ID=$(docker ps -qf 'name=buildx_buildkit')
|
||||
for container in ${containers}; do
|
||||
if [[ "${container}" == "${BUILDX_CONTAINER_ID}" ]]; then
|
||||
echo "skipping buildx container in docker stop"
|
||||
else
|
||||
echo "Stopping container ${container}"
|
||||
docker stop ${container}
|
||||
fi
|
||||
done
|
||||
docker stop ${containers}
|
||||
fi
|
||||
docker system prune -f --volumes || :
|
||||
docker image prune -af || :
|
||||
'''
|
||||
docker system prune -af --volumes || : '''
|
||||
script{
|
||||
env.EXIT_STATUS = ''
|
||||
env.LS_RELEASE = sh(
|
||||
@ -96,12 +68,8 @@ pipeline {
|
||||
env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/commit/' + env.GIT_COMMIT
|
||||
env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DOCKERHUB_IMAGE + '/tags/'
|
||||
env.PULL_REQUEST = env.CHANGE_ID
|
||||
env.TEMPLATED_FILES = 'Jenkinsfile README.md LICENSE .editorconfig ./.github/CONTRIBUTING.md ./.github/FUNDING.yml ./.github/ISSUE_TEMPLATE/config.yml ./.github/ISSUE_TEMPLATE/issue.bug.yml ./.github/ISSUE_TEMPLATE/issue.feature.yml ./.github/PULL_REQUEST_TEMPLATE.md ./.github/workflows/external_trigger_scheduler.yml ./.github/workflows/greetings.yml ./.github/workflows/package_trigger_scheduler.yml ./.github/workflows/call_issue_pr_tracker.yml ./.github/workflows/call_issues_cron.yml ./.github/workflows/permissions.yml ./.github/workflows/external_trigger.yml'
|
||||
if ( env.SYFT_IMAGE_TAG == null ) {
|
||||
env.SYFT_IMAGE_TAG = 'latest'
|
||||
}
|
||||
env.TEMPLATED_FILES = 'Jenkinsfile README.md LICENSE .editorconfig ./.github/CONTRIBUTING.md ./.github/FUNDING.yml ./.github/ISSUE_TEMPLATE/config.yml ./.github/ISSUE_TEMPLATE/issue.bug.yml ./.github/ISSUE_TEMPLATE/issue.feature.yml ./.github/PULL_REQUEST_TEMPLATE.md ./.github/workflows/external_trigger_scheduler.yml ./.github/workflows/greetings.yml ./.github/workflows/package_trigger_scheduler.yml ./.github/workflows/call_issue_pr_tracker.yml ./.github/workflows/call_issues_cron.yml ./.github/workflows/permissions.yml ./.github/workflows/external_trigger.yml ./.github/workflows/package_trigger.yml'
|
||||
}
|
||||
echo "Using syft image tag ${SYFT_IMAGE_TAG}"
|
||||
sh '''#! /bin/bash
|
||||
echo "The default github branch detected as ${GH_DEFAULT_BRANCH}" '''
|
||||
script{
|
||||
@ -217,8 +185,6 @@ pipeline {
|
||||
env.VERSION_TAG = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER
|
||||
env.META_TAG = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER
|
||||
env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN
|
||||
env.BUILDCACHE = 'docker.io/lsiodev/buildcache,registry.gitlab.com/linuxserver.io/docker-jenkins-builder/lsiodev-buildcache,ghcr.io/linuxserver/lsiodev-buildcache,quay.io/linuxserver.io/lsiodev-buildcache'
|
||||
env.CITEST_IMAGETAG = 'latest'
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -243,8 +209,6 @@ pipeline {
|
||||
env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA
|
||||
env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN
|
||||
env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DEV_DOCKERHUB_IMAGE + '/tags/'
|
||||
env.BUILDCACHE = 'docker.io/lsiodev/buildcache,registry.gitlab.com/linuxserver.io/docker-jenkins-builder/lsiodev-buildcache,ghcr.io/linuxserver/lsiodev-buildcache,quay.io/linuxserver.io/lsiodev-buildcache'
|
||||
env.CITEST_IMAGETAG = 'develop'
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -269,8 +233,6 @@ pipeline {
|
||||
env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN
|
||||
env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/pull/' + env.PULL_REQUEST
|
||||
env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.PR_DOCKERHUB_IMAGE + '/tags/'
|
||||
env.BUILDCACHE = 'docker.io/lsiodev/buildcache,registry.gitlab.com/linuxserver.io/docker-jenkins-builder/lsiodev-buildcache,ghcr.io/linuxserver/lsiodev-buildcache,quay.io/linuxserver.io/lsiodev-buildcache'
|
||||
env.CITEST_IMAGETAG = 'develop'
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -293,7 +255,7 @@ pipeline {
|
||||
-v ${WORKSPACE}:/mnt \
|
||||
-e AWS_ACCESS_KEY_ID=\"${S3_KEY}\" \
|
||||
-e AWS_SECRET_ACCESS_KEY=\"${S3_SECRET}\" \
|
||||
ghcr.io/linuxserver/baseimage-alpine:3.23 s6-envdir -fn -- /var/run/s6/container_environment /bin/bash -c "\
|
||||
ghcr.io/linuxserver/baseimage-alpine:3.19 s6-envdir -fn -- /var/run/s6/container_environment /bin/bash -c "\
|
||||
apk add --no-cache python3 && \
|
||||
python3 -m venv /lsiopy && \
|
||||
pip install --no-cache-dir -U pip && \
|
||||
@ -316,15 +278,8 @@ pipeline {
|
||||
set -e
|
||||
TEMPDIR=$(mktemp -d)
|
||||
docker pull ghcr.io/linuxserver/jenkins-builder:latest
|
||||
# Cloned repo paths for templating:
|
||||
# ${TEMPDIR}/docker-${CONTAINER_NAME}: Cloned branch master of ${LS_USER}/${LS_REPO} for running the jenkins builder on
|
||||
# ${TEMPDIR}/repo/${LS_REPO}: Cloned branch master of ${LS_USER}/${LS_REPO} for commiting various templated file changes and pushing back to Github
|
||||
# ${TEMPDIR}/docs/docker-documentation: Cloned docs repo for pushing docs updates to Github
|
||||
# ${TEMPDIR}/unraid/docker-templates: Cloned docker-templates repo to check for logos
|
||||
# ${TEMPDIR}/unraid/templates: Cloned templates repo for commiting unraid template changes and pushing back to Github
|
||||
git clone --branch master --depth 1 https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/docker-${CONTAINER_NAME}
|
||||
docker run --rm -v ${TEMPDIR}/docker-${CONTAINER_NAME}:/tmp -e LOCAL=true -e PUID=$(id -u) -e PGID=$(id -g) ghcr.io/linuxserver/jenkins-builder:latest
|
||||
echo "Starting Stage 1 - Jenkinsfile update"
|
||||
docker run --rm -e CONTAINER_NAME=${CONTAINER_NAME} -e GITHUB_BRANCH=master -v ${TEMPDIR}:/ansible/jenkins ghcr.io/linuxserver/jenkins-builder:latest
|
||||
# Stage 1 - Jenkinsfile update
|
||||
if [[ "$(md5sum Jenkinsfile | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/Jenkinsfile | awk '{ print $1 }')" ]]; then
|
||||
mkdir -p ${TEMPDIR}/repo
|
||||
git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO}
|
||||
@ -336,14 +291,14 @@ pipeline {
|
||||
git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master
|
||||
git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master
|
||||
echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
|
||||
echo "Updating Jenkinsfile and exiting build, new one will trigger based on commit"
|
||||
echo "Updating Jenkinsfile"
|
||||
rm -Rf ${TEMPDIR}
|
||||
exit 0
|
||||
else
|
||||
echo "Jenkinsfile is up to date."
|
||||
fi
|
||||
echo "Starting Stage 2 - Delete old templates"
|
||||
OLD_TEMPLATES=".github/ISSUE_TEMPLATE.md .github/ISSUE_TEMPLATE/issue.bug.md .github/ISSUE_TEMPLATE/issue.feature.md .github/workflows/call_invalid_helper.yml .github/workflows/stale.yml .github/workflows/package_trigger.yml"
|
||||
# Stage 2 - Delete old templates
|
||||
OLD_TEMPLATES=".github/ISSUE_TEMPLATE.md .github/ISSUE_TEMPLATE/issue.bug.md .github/ISSUE_TEMPLATE/issue.feature.md .github/workflows/call_invalid_helper.yml .github/workflows/stale.yml Dockerfile.armhf"
|
||||
for i in ${OLD_TEMPLATES}; do
|
||||
if [[ -f "${i}" ]]; then
|
||||
TEMPLATES_TO_DELETE="${i} ${TEMPLATES_TO_DELETE}"
|
||||
@ -361,42 +316,13 @@ pipeline {
|
||||
git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master
|
||||
git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master
|
||||
echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
|
||||
echo "Deleting old/deprecated templates and exiting build, new one will trigger based on commit"
|
||||
echo "Deleting old and deprecated templates"
|
||||
rm -Rf ${TEMPDIR}
|
||||
exit 0
|
||||
else
|
||||
echo "No templates to delete"
|
||||
fi
|
||||
echo "Starting Stage 2.5 - Update init diagram"
|
||||
if ! grep -q 'init_diagram:' readme-vars.yml; then
|
||||
echo "Adding the key 'init_diagram' to readme-vars.yml"
|
||||
sed -i '\\|^#.*changelog.*$|d' readme-vars.yml
|
||||
sed -i 's|^changelogs:|# init diagram\\ninit_diagram:\\n\\n# changelog\\nchangelogs:|' readme-vars.yml
|
||||
fi
|
||||
mkdir -p ${TEMPDIR}/d2
|
||||
docker run --rm -v ${TEMPDIR}/d2:/output -e PUID=$(id -u) -e PGID=$(id -g) -e RAW="true" ghcr.io/linuxserver/d2-builder:latest ${CONTAINER_NAME}:latest
|
||||
ls -al ${TEMPDIR}/d2
|
||||
yq -ei ".init_diagram |= load_str(\\"${TEMPDIR}/d2/${CONTAINER_NAME}-latest.d2\\")" readme-vars.yml
|
||||
if [[ $(md5sum readme-vars.yml | cut -c1-8) != $(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/readme-vars.yml | cut -c1-8) ]]; then
|
||||
echo "'init_diagram' has been updated. Updating repo and exiting build, new one will trigger based on commit."
|
||||
mkdir -p ${TEMPDIR}/repo
|
||||
git clone https://github.com/${LS_USER}/${LS_REPO}.git ${TEMPDIR}/repo/${LS_REPO}
|
||||
cd ${TEMPDIR}/repo/${LS_REPO}
|
||||
git checkout -f master
|
||||
cp ${WORKSPACE}/readme-vars.yml ${TEMPDIR}/repo/${LS_REPO}/readme-vars.yml
|
||||
git add readme-vars.yml
|
||||
git commit -m 'Bot Updating Templated Files'
|
||||
git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master
|
||||
git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master
|
||||
echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
|
||||
echo "Updating templates and exiting build, new one will trigger based on commit"
|
||||
rm -Rf ${TEMPDIR}
|
||||
exit 0
|
||||
else
|
||||
echo "false" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
|
||||
echo "Init diagram is unchanged"
|
||||
fi
|
||||
echo "Starting Stage 3 - Update templates"
|
||||
# Stage 3 - Update templates
|
||||
CURRENTHASH=$(grep -hs ^ ${TEMPLATED_FILES} | md5sum | cut -c1-8)
|
||||
cd ${TEMPDIR}/docker-${CONTAINER_NAME}
|
||||
NEWHASH=$(grep -hs ^ ${TEMPLATED_FILES} | md5sum | cut -c1-8)
|
||||
@ -420,22 +346,16 @@ pipeline {
|
||||
git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master
|
||||
git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git master
|
||||
echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
|
||||
echo "Updating templates and exiting build, new one will trigger based on commit"
|
||||
rm -Rf ${TEMPDIR}
|
||||
exit 0
|
||||
else
|
||||
echo "false" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
|
||||
echo "No templates to update"
|
||||
fi
|
||||
echo "Starting Stage 4 - External repo updates: Docs, Unraid Template and Readme Sync to Docker Hub"
|
||||
mkdir -p ${TEMPDIR}/docs
|
||||
git clone --depth=1 https://github.com/linuxserver/docker-documentation.git ${TEMPDIR}/docs/docker-documentation
|
||||
git clone https://github.com/linuxserver/docker-documentation.git ${TEMPDIR}/docs/docker-documentation
|
||||
if [[ "${BRANCH_NAME}" == "${GH_DEFAULT_BRANCH}" ]] && [[ (! -f ${TEMPDIR}/docs/docker-documentation/docs/images/docker-${CONTAINER_NAME}.md) || ("$(md5sum ${TEMPDIR}/docs/docker-documentation/docs/images/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')") ]]; then
|
||||
cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md ${TEMPDIR}/docs/docker-documentation/docs/images/
|
||||
cd ${TEMPDIR}/docs/docker-documentation
|
||||
GH_DOCS_DEFAULT_BRANCH=$(git remote show origin | grep "HEAD branch:" | sed 's|.*HEAD branch: ||')
|
||||
git add docs/images/docker-${CONTAINER_NAME}.md
|
||||
echo "Updating docs repo"
|
||||
git commit -m 'Bot Updating Documentation'
|
||||
git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH} --rebase
|
||||
git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH} || \
|
||||
@ -443,24 +363,19 @@ pipeline {
|
||||
sleep $((RANDOM % MAXWAIT)) && \
|
||||
git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH} --rebase && \
|
||||
git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH})
|
||||
else
|
||||
echo "Docs update not needed, skipping"
|
||||
fi
|
||||
mkdir -p ${TEMPDIR}/unraid
|
||||
git clone --depth=1 https://github.com/linuxserver/docker-templates.git ${TEMPDIR}/unraid/docker-templates
|
||||
git clone --depth=1 https://github.com/linuxserver/templates.git ${TEMPDIR}/unraid/templates
|
||||
git clone https://github.com/linuxserver/docker-templates.git ${TEMPDIR}/unraid/docker-templates
|
||||
git clone https://github.com/linuxserver/templates.git ${TEMPDIR}/unraid/templates
|
||||
if [[ -f ${TEMPDIR}/unraid/docker-templates/linuxserver.io/img/${CONTAINER_NAME}-logo.png ]]; then
|
||||
sed -i "s|master/linuxserver.io/img/linuxserver-ls-logo.png|master/linuxserver.io/img/${CONTAINER_NAME}-logo.png|" ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml
|
||||
elif [[ -f ${TEMPDIR}/unraid/docker-templates/linuxserver.io/img/${CONTAINER_NAME}-icon.png ]]; then
|
||||
sed -i "s|master/linuxserver.io/img/linuxserver-ls-logo.png|master/linuxserver.io/img/${CONTAINER_NAME}-icon.png|" ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml
|
||||
fi
|
||||
if [[ "${BRANCH_NAME}" == "${GH_DEFAULT_BRANCH}" ]] && [[ (! -f ${TEMPDIR}/unraid/templates/unraid/${CONTAINER_NAME}.xml) || ("$(md5sum ${TEMPDIR}/unraid/templates/unraid/${CONTAINER_NAME}.xml | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml | awk '{ print $1 }')") ]]; then
|
||||
echo "Updating Unraid template"
|
||||
cd ${TEMPDIR}/unraid/templates/
|
||||
GH_TEMPLATES_DEFAULT_BRANCH=$(git remote show origin | grep "HEAD branch:" | sed 's|.*HEAD branch: ||')
|
||||
if grep -wq "^${CONTAINER_NAME}$" ${TEMPDIR}/unraid/templates/unraid/ignore.list && [[ -f ${TEMPDIR}/unraid/templates/unraid/deprecated/${CONTAINER_NAME}.xml ]]; then
|
||||
echo "Image is on the ignore list, and already in the deprecation folder."
|
||||
elif grep -wq "^${CONTAINER_NAME}$" ${TEMPDIR}/unraid/templates/unraid/ignore.list; then
|
||||
if grep -wq "${CONTAINER_NAME}" ${TEMPDIR}/unraid/templates/unraid/ignore.list; then
|
||||
echo "Image is on the ignore list, marking Unraid template as deprecated"
|
||||
cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml ${TEMPDIR}/unraid/templates/unraid/
|
||||
git add -u unraid/${CONTAINER_NAME}.xml
|
||||
@ -477,27 +392,16 @@ pipeline {
|
||||
sleep $((RANDOM % MAXWAIT)) && \
|
||||
git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/templates.git ${GH_TEMPLATES_DEFAULT_BRANCH} --rebase && \
|
||||
git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/templates.git ${GH_TEMPLATES_DEFAULT_BRANCH})
|
||||
else
|
||||
echo "No updates to Unraid template needed, skipping"
|
||||
fi
|
||||
# Stage 4 - Sync Readme to Docker Hub
|
||||
if [[ "${BRANCH_NAME}" == "${GH_DEFAULT_BRANCH}" ]]; then
|
||||
if [[ $(cat ${TEMPDIR}/docker-${CONTAINER_NAME}/README.md | wc -m) -gt 25000 ]]; then
|
||||
if [[ $(cat ${TEMPDIR}/docker-${CONTAINER_NAME}/README.md | wc -m) > 25000 ]]; then
|
||||
echo "Readme is longer than 25,000 characters. Syncing the lite version to Docker Hub"
|
||||
DH_README_SYNC_PATH="${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/README.lite"
|
||||
else
|
||||
echo "Syncing readme to Docker Hub"
|
||||
DH_README_SYNC_PATH="${TEMPDIR}/docker-${CONTAINER_NAME}/README.md"
|
||||
fi
|
||||
if curl -s https://hub.docker.com/v2/namespaces/${DOCKERHUB_IMAGE%%/*}/repositories/${DOCKERHUB_IMAGE##*/}/tags | jq -r '.message' | grep -q 404; then
|
||||
echo "Docker Hub endpoint doesn't exist. Creating endpoint first."
|
||||
DH_TOKEN=$(curl -d '{"username":"linuxserverci", "password":"'${DOCKERHUB_TOKEN}'"}' -H "Content-Type: application/json" -X POST https://hub.docker.com/v2/users/login | jq -r '.token')
|
||||
curl -s \
|
||||
-H "Authorization: JWT ${DH_TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-X POST \
|
||||
-d '{"name":"'${DOCKERHUB_IMAGE##*/}'", "namespace":"'${DOCKERHUB_IMAGE%%/*}'"}' \
|
||||
https://hub.docker.com/v2/repositories/ || :
|
||||
fi
|
||||
DH_TOKEN=$(curl -d '{"username":"linuxserverci", "password":"'${DOCKERHUB_TOKEN}'"}' -H "Content-Type: application/json" -X POST https://hub.docker.com/v2/users/login | jq -r '.token')
|
||||
curl -s \
|
||||
-H "Authorization: JWT ${DH_TOKEN}" \
|
||||
@ -553,27 +457,23 @@ pipeline {
|
||||
}
|
||||
}
|
||||
/* #######################
|
||||
GitLab Mirroring and Quay.io Repo Visibility
|
||||
GitLab Mirroring
|
||||
####################### */
|
||||
// Ping into Gitlab to mirror this repo and have a registry endpoint & mark this repo on Quay.io as public
|
||||
stage("GitLab Mirror and Quay.io Visibility"){
|
||||
// Ping into Gitlab to mirror this repo and have a registry endpoint
|
||||
stage("GitLab Mirror"){
|
||||
when {
|
||||
environment name: 'EXIT_STATUS', value: ''
|
||||
}
|
||||
steps{
|
||||
sh '''curl -H "Content-Type: application/json" -H "Private-Token: ${GITLAB_TOKEN}" -X POST https://gitlab.com/api/v4/projects \
|
||||
-d '{"namespace_id":'${GITLAB_NAMESPACE}',\
|
||||
"name":"'${LS_REPO}'",
|
||||
"mirror":true,\
|
||||
"import_url":"https://github.com/linuxserver/'${LS_REPO}'.git",\
|
||||
"issues_access_level":"disabled",\
|
||||
"merge_requests_access_level":"disabled",\
|
||||
"repository_access_level":"enabled",\
|
||||
"visibility":"public"}' '''
|
||||
sh '''curl -H "Private-Token: ${GITLAB_TOKEN}" -X PUT "https://gitlab.com/api/v4/projects/Linuxserver.io%2F${LS_REPO}" \
|
||||
-d "mirror=true&import_url=https://github.com/linuxserver/${LS_REPO}.git" '''
|
||||
sh '''curl -H "Content-Type: application/json" -H "Authorization: Bearer ${QUAYIO_API_TOKEN}" -X POST "https://quay.io/api/v1/repository${QUAYIMAGE/quay.io/}/changevisibility" \
|
||||
-d '{"visibility":"public"}' ||: '''
|
||||
-d '{"namespace_id":'${GITLAB_NAMESPACE}',\
|
||||
"name":"'${LS_REPO}'",
|
||||
"mirror":true,\
|
||||
"import_url":"https://github.com/linuxserver/'${LS_REPO}'.git",\
|
||||
"issues_access_level":"disabled",\
|
||||
"merge_requests_access_level":"disabled",\
|
||||
"repository_access_level":"enabled",\
|
||||
"visibility":"public"}' '''
|
||||
}
|
||||
}
|
||||
/* ###############
|
||||
@ -604,45 +504,7 @@ pipeline {
|
||||
--label \"org.opencontainers.image.title=Bookstack\" \
|
||||
--label \"org.opencontainers.image.description=[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 \" \
|
||||
--no-cache --pull -t ${IMAGE}:${META_TAG} --platform=linux/amd64 \
|
||||
--provenance=true --sbom=true --builder=container --load \
|
||||
--build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
|
||||
sh '''#! /bin/bash
|
||||
set -e
|
||||
IFS=',' read -ra CACHE <<< "$BUILDCACHE"
|
||||
for i in "${CACHE[@]}"; do
|
||||
docker tag ${IMAGE}:${META_TAG} ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER}
|
||||
done
|
||||
'''
|
||||
withCredentials([
|
||||
[
|
||||
$class: 'UsernamePasswordMultiBinding',
|
||||
credentialsId: 'Quay.io-Robot',
|
||||
usernameVariable: 'QUAYUSER',
|
||||
passwordVariable: 'QUAYPASS'
|
||||
]
|
||||
]) {
|
||||
retry_backoff(5,5) {
|
||||
sh '''#! /bin/bash
|
||||
set -e
|
||||
echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin
|
||||
echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin
|
||||
echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin
|
||||
echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin
|
||||
|
||||
if [[ "${PACKAGE_CHECK}" != "true" ]]; then
|
||||
declare -A pids
|
||||
IFS=',' read -ra CACHE <<< "$BUILDCACHE"
|
||||
for i in "${CACHE[@]}"; do
|
||||
docker push ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} &
|
||||
pids[$!]="$i"
|
||||
done
|
||||
for p in "${!pids[@]}"; do
|
||||
wait "$p" || { [[ "${pids[$p]}" != *"quay.io"* ]] && exit 1; }
|
||||
done
|
||||
fi
|
||||
'''
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// Build MultiArch Docker containers for push to LS Repo
|
||||
@ -673,45 +535,7 @@ pipeline {
|
||||
--label \"org.opencontainers.image.title=Bookstack\" \
|
||||
--label \"org.opencontainers.image.description=[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 \" \
|
||||
--no-cache --pull -t ${IMAGE}:amd64-${META_TAG} --platform=linux/amd64 \
|
||||
--provenance=true --sbom=true --builder=container --load \
|
||||
--build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
|
||||
sh '''#! /bin/bash
|
||||
set -e
|
||||
IFS=',' read -ra CACHE <<< "$BUILDCACHE"
|
||||
for i in "${CACHE[@]}"; do
|
||||
docker tag ${IMAGE}:amd64-${META_TAG} ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER}
|
||||
done
|
||||
'''
|
||||
withCredentials([
|
||||
[
|
||||
$class: 'UsernamePasswordMultiBinding',
|
||||
credentialsId: 'Quay.io-Robot',
|
||||
usernameVariable: 'QUAYUSER',
|
||||
passwordVariable: 'QUAYPASS'
|
||||
]
|
||||
]) {
|
||||
retry_backoff(5,5) {
|
||||
sh '''#! /bin/bash
|
||||
set -e
|
||||
echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin
|
||||
echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin
|
||||
echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin
|
||||
echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin
|
||||
|
||||
if [[ "${PACKAGE_CHECK}" != "true" ]]; then
|
||||
declare -A pids
|
||||
IFS=',' read -ra CACHE <<< "$BUILDCACHE"
|
||||
for i in "${CACHE[@]}"; do
|
||||
docker push ${i}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} &
|
||||
pids[$!]="$i"
|
||||
done
|
||||
for p in "${!pids[@]}"; do
|
||||
wait "$p" || { [[ "${pids[$p]}" != *"quay.io"* ]] && exit 1; }
|
||||
done
|
||||
fi
|
||||
'''
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
stage('Build ARM64') {
|
||||
@ -720,6 +544,10 @@ pipeline {
|
||||
}
|
||||
steps {
|
||||
echo "Running on node: ${NODE_NAME}"
|
||||
echo 'Logging into Github'
|
||||
sh '''#! /bin/bash
|
||||
echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin
|
||||
'''
|
||||
sh "sed -r -i 's|(^FROM .*)|\\1\\n\\nENV LSIO_FIRST_PARTY=true|g' Dockerfile.aarch64"
|
||||
sh "docker buildx build \
|
||||
--label \"org.opencontainers.image.created=${GITHUB_DATE}\" \
|
||||
@ -735,52 +563,17 @@ pipeline {
|
||||
--label \"org.opencontainers.image.title=Bookstack\" \
|
||||
--label \"org.opencontainers.image.description=[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 \" \
|
||||
--no-cache --pull -f Dockerfile.aarch64 -t ${IMAGE}:arm64v8-${META_TAG} --platform=linux/arm64 \
|
||||
--provenance=true --sbom=true --builder=container --load \
|
||||
--build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
|
||||
sh '''#! /bin/bash
|
||||
set -e
|
||||
IFS=',' read -ra CACHE <<< "$BUILDCACHE"
|
||||
for i in "${CACHE[@]}"; do
|
||||
docker tag ${IMAGE}:arm64v8-${META_TAG} ${i}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER}
|
||||
done
|
||||
'''
|
||||
withCredentials([
|
||||
[
|
||||
$class: 'UsernamePasswordMultiBinding',
|
||||
credentialsId: 'Quay.io-Robot',
|
||||
usernameVariable: 'QUAYUSER',
|
||||
passwordVariable: 'QUAYPASS'
|
||||
]
|
||||
]) {
|
||||
retry_backoff(5,5) {
|
||||
sh '''#! /bin/bash
|
||||
set -e
|
||||
echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin
|
||||
echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin
|
||||
echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin
|
||||
echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin
|
||||
if [[ "${PACKAGE_CHECK}" != "true" ]]; then
|
||||
declare -A pids
|
||||
IFS=',' read -ra CACHE <<< "$BUILDCACHE"
|
||||
for i in "${CACHE[@]}"; do
|
||||
docker push ${i}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} &
|
||||
pids[$!]="$i"
|
||||
done
|
||||
for p in "${!pids[@]}"; do
|
||||
wait "$p" || { [[ "${pids[$p]}" != *"quay.io"* ]] && exit 1; }
|
||||
done
|
||||
fi
|
||||
'''
|
||||
}
|
||||
sh "docker tag ${IMAGE}:arm64v8-${META_TAG} ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER}"
|
||||
retry(5) {
|
||||
sh "docker push ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER}"
|
||||
}
|
||||
sh '''#! /bin/bash
|
||||
containers=$(docker ps -aq)
|
||||
if [[ -n "${containers}" ]]; then
|
||||
docker stop ${containers}
|
||||
fi
|
||||
docker system prune -f --volumes || :
|
||||
docker image prune -af || :
|
||||
'''
|
||||
docker system prune -af --volumes || : '''
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -796,7 +589,7 @@ pipeline {
|
||||
sh '''#! /bin/bash
|
||||
set -e
|
||||
TEMPDIR=$(mktemp -d)
|
||||
if [ "${MULTIARCH}" == "true" ] && [ "${PACKAGE_CHECK}" != "true" ]; then
|
||||
if [ "${MULTIARCH}" == "true" ] && [ "${PACKAGE_CHECK}" == "false" ]; then
|
||||
LOCAL_CONTAINER=${IMAGE}:amd64-${META_TAG}
|
||||
else
|
||||
LOCAL_CONTAINER=${IMAGE}:${META_TAG}
|
||||
@ -805,7 +598,7 @@ pipeline {
|
||||
docker run --rm \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock:ro \
|
||||
-v ${TEMPDIR}:/tmp \
|
||||
ghcr.io/anchore/syft:${SYFT_IMAGE_TAG} \
|
||||
ghcr.io/anchore/syft:latest \
|
||||
${LOCAL_CONTAINER} -o table=/tmp/package_versions.txt
|
||||
NEW_PACKAGE_TAG=$(md5sum ${TEMPDIR}/package_versions.txt | cut -c1-8 )
|
||||
echo "Package tag sha from current packages in buit container is ${NEW_PACKAGE_TAG} comparing to old ${PACKAGE_TAG} from github"
|
||||
@ -884,27 +677,18 @@ pipeline {
|
||||
}
|
||||
sh '''#! /bin/bash
|
||||
set -e
|
||||
if grep -q 'docker-baseimage' <<< "${LS_REPO}"; then
|
||||
echo "Detected baseimage, setting LSIO_FIRST_PARTY=true"
|
||||
if [ -n "${CI_DOCKERENV}" ]; then
|
||||
CI_DOCKERENV="LSIO_FIRST_PARTY=true|${CI_DOCKERENV}"
|
||||
else
|
||||
CI_DOCKERENV="LSIO_FIRST_PARTY=true"
|
||||
fi
|
||||
fi
|
||||
docker pull ghcr.io/linuxserver/ci:${CITEST_IMAGETAG}
|
||||
docker pull ghcr.io/linuxserver/ci:latest
|
||||
if [ "${MULTIARCH}" == "true" ]; then
|
||||
docker pull ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} --platform=arm64
|
||||
docker pull ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER}
|
||||
docker tag ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} ${IMAGE}:arm64v8-${META_TAG}
|
||||
fi
|
||||
docker run --rm \
|
||||
--shm-size=1gb \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
-e IMAGE=\"${IMAGE}\" \
|
||||
-e DOCKER_LOGS_TIMEOUT=\"${CI_DELAY}\" \
|
||||
-e DELAY_START=\"${CI_DELAY}\" \
|
||||
-e TAGS=\"${CI_TAGS}\" \
|
||||
-e META_TAG=\"${META_TAG}\" \
|
||||
-e RELEASE_TAG=\"latest\" \
|
||||
-e PORT=\"${CI_PORT}\" \
|
||||
-e SSL=\"${CI_SSL}\" \
|
||||
-e BASE=\"${DIST_IMAGE}\" \
|
||||
@ -914,11 +698,7 @@ pipeline {
|
||||
-e WEB_SCREENSHOT=\"${CI_WEB}\" \
|
||||
-e WEB_AUTH=\"${CI_AUTH}\" \
|
||||
-e WEB_PATH=\"${CI_WEBPATH}\" \
|
||||
-e NODE_NAME=\"${NODE_NAME}\" \
|
||||
-e SYFT_IMAGE_TAG=\"${CI_SYFT_IMAGE_TAG:-${SYFT_IMAGE_TAG}}\" \
|
||||
-e COMMIT_SHA=\"${COMMIT_SHA}\" \
|
||||
-e BUILD_NUMBER=\"${BUILD_NUMBER}\" \
|
||||
-t ghcr.io/linuxserver/ci:${CITEST_IMAGETAG} \
|
||||
-t ghcr.io/linuxserver/ci:latest \
|
||||
python3 test_build.py'''
|
||||
}
|
||||
}
|
||||
@ -933,25 +713,37 @@ pipeline {
|
||||
environment name: 'EXIT_STATUS', value: ''
|
||||
}
|
||||
steps {
|
||||
retry_backoff(5,5) {
|
||||
sh '''#! /bin/bash
|
||||
set -e
|
||||
for PUSHIMAGE in "${IMAGE}" "${GITLABIMAGE}" "${GITHUBIMAGE}" "${QUAYIMAGE}"; do
|
||||
[[ ${PUSHIMAGE%%/*} =~ \\. ]] && PUSHIMAGEPLUS="${PUSHIMAGE}" || PUSHIMAGEPLUS="docker.io/${PUSHIMAGE}"
|
||||
IFS=',' read -ra CACHE <<< "$BUILDCACHE"
|
||||
for i in "${CACHE[@]}"; do
|
||||
if [[ "${PUSHIMAGEPLUS}" == "$(cut -d "/" -f1 <<< ${i})"* ]]; then
|
||||
CACHEIMAGE=${i}
|
||||
fi
|
||||
withCredentials([
|
||||
[
|
||||
$class: 'UsernamePasswordMultiBinding',
|
||||
credentialsId: 'Quay.io-Robot',
|
||||
usernameVariable: 'QUAYUSER',
|
||||
passwordVariable: 'QUAYPASS'
|
||||
]
|
||||
]) {
|
||||
retry(5) {
|
||||
sh '''#! /bin/bash
|
||||
set -e
|
||||
echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin
|
||||
echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin
|
||||
echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin
|
||||
echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin
|
||||
for PUSHIMAGE in "${GITHUBIMAGE}" "${GITLABIMAGE}" "${QUAYIMAGE}" "${IMAGE}"; do
|
||||
docker tag ${IMAGE}:${META_TAG} ${PUSHIMAGE}:${META_TAG}
|
||||
docker tag ${PUSHIMAGE}:${META_TAG} ${PUSHIMAGE}:latest
|
||||
docker tag ${PUSHIMAGE}:${META_TAG} ${PUSHIMAGE}:${EXT_RELEASE_TAG}
|
||||
if [ -n "${SEMVER}" ]; then
|
||||
docker tag ${PUSHIMAGE}:${META_TAG} ${PUSHIMAGE}:${SEMVER}
|
||||
fi
|
||||
docker push ${PUSHIMAGE}:latest
|
||||
docker push ${PUSHIMAGE}:${META_TAG}
|
||||
docker push ${PUSHIMAGE}:${EXT_RELEASE_TAG}
|
||||
if [ -n "${SEMVER}" ]; then
|
||||
docker push ${PUSHIMAGE}:${SEMVER}
|
||||
fi
|
||||
done
|
||||
docker buildx imagetools create --prefer-index=false -t ${PUSHIMAGE}:${META_TAG} -t ${PUSHIMAGE}:latest -t ${PUSHIMAGE}:${EXT_RELEASE_TAG} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} || \
|
||||
{ if [[ "${PUSHIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; }
|
||||
if [ -n "${SEMVER}" ]; then
|
||||
docker buildx imagetools create --prefer-index=false -t ${PUSHIMAGE}:${SEMVER} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} || \
|
||||
{ if [[ "${PUSHIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; }
|
||||
fi
|
||||
done
|
||||
'''
|
||||
'''
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -962,41 +754,79 @@ pipeline {
|
||||
environment name: 'EXIT_STATUS', value: ''
|
||||
}
|
||||
steps {
|
||||
retry_backoff(5,5) {
|
||||
sh '''#! /bin/bash
|
||||
set -e
|
||||
for MANIFESTIMAGE in "${IMAGE}" "${GITLABIMAGE}" "${GITHUBIMAGE}" "${QUAYIMAGE}"; do
|
||||
[[ ${MANIFESTIMAGE%%/*} =~ \\. ]] && MANIFESTIMAGEPLUS="${MANIFESTIMAGE}" || MANIFESTIMAGEPLUS="docker.io/${MANIFESTIMAGE}"
|
||||
IFS=',' read -ra CACHE <<< "$BUILDCACHE"
|
||||
for i in "${CACHE[@]}"; do
|
||||
if [[ "${MANIFESTIMAGEPLUS}" == "$(cut -d "/" -f1 <<< ${i})"* ]]; then
|
||||
CACHEIMAGE=${i}
|
||||
fi
|
||||
withCredentials([
|
||||
[
|
||||
$class: 'UsernamePasswordMultiBinding',
|
||||
credentialsId: 'Quay.io-Robot',
|
||||
usernameVariable: 'QUAYUSER',
|
||||
passwordVariable: 'QUAYPASS'
|
||||
]
|
||||
]) {
|
||||
retry(5) {
|
||||
sh '''#! /bin/bash
|
||||
set -e
|
||||
echo $DOCKERHUB_TOKEN | docker login -u linuxserverci --password-stdin
|
||||
echo $GITHUB_TOKEN | docker login ghcr.io -u LinuxServer-CI --password-stdin
|
||||
echo $GITLAB_TOKEN | docker login registry.gitlab.com -u LinuxServer.io --password-stdin
|
||||
echo $QUAYPASS | docker login quay.io -u $QUAYUSER --password-stdin
|
||||
if [ "${CI}" == "false" ]; then
|
||||
docker pull ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER}
|
||||
docker tag ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} ${IMAGE}:arm64v8-${META_TAG}
|
||||
fi
|
||||
for MANIFESTIMAGE in "${IMAGE}" "${GITLABIMAGE}" "${GITHUBIMAGE}" "${QUAYIMAGE}"; do
|
||||
docker tag ${IMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:amd64-${META_TAG}
|
||||
docker tag ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:amd64-latest
|
||||
docker tag ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG}
|
||||
docker tag ${IMAGE}:arm64v8-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG}
|
||||
docker tag ${MANIFESTIMAGE}:arm64v8-${META_TAG} ${MANIFESTIMAGE}:arm64v8-latest
|
||||
docker tag ${MANIFESTIMAGE}:arm64v8-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG}
|
||||
if [ -n "${SEMVER}" ]; then
|
||||
docker tag ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:amd64-${SEMVER}
|
||||
docker tag ${MANIFESTIMAGE}:arm64v8-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${SEMVER}
|
||||
fi
|
||||
docker push ${MANIFESTIMAGE}:amd64-${META_TAG}
|
||||
docker push ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG}
|
||||
docker push ${MANIFESTIMAGE}:amd64-latest
|
||||
docker push ${MANIFESTIMAGE}:arm64v8-${META_TAG}
|
||||
docker push ${MANIFESTIMAGE}:arm64v8-latest
|
||||
docker push ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG}
|
||||
if [ -n "${SEMVER}" ]; then
|
||||
docker push ${MANIFESTIMAGE}:amd64-${SEMVER}
|
||||
docker push ${MANIFESTIMAGE}:arm64v8-${SEMVER}
|
||||
fi
|
||||
docker manifest push --purge ${MANIFESTIMAGE}:latest || :
|
||||
docker manifest create ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:amd64-latest ${MANIFESTIMAGE}:arm64v8-latest
|
||||
docker manifest annotate ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:arm64v8-latest --os linux --arch arm64 --variant v8
|
||||
docker manifest push --purge ${MANIFESTIMAGE}:${META_TAG} || :
|
||||
docker manifest create ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG}
|
||||
docker manifest annotate ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG} --os linux --arch arm64 --variant v8
|
||||
docker manifest push --purge ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} || :
|
||||
docker manifest create ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG}
|
||||
docker manifest annotate ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG} --os linux --arch arm64 --variant v8
|
||||
if [ -n "${SEMVER}" ]; then
|
||||
docker manifest push --purge ${MANIFESTIMAGE}:${SEMVER} || :
|
||||
docker manifest create ${MANIFESTIMAGE}:${SEMVER} ${MANIFESTIMAGE}:amd64-${SEMVER} ${MANIFESTIMAGE}:arm64v8-${SEMVER}
|
||||
docker manifest annotate ${MANIFESTIMAGE}:${SEMVER} ${MANIFESTIMAGE}:arm64v8-${SEMVER} --os linux --arch arm64 --variant v8
|
||||
fi
|
||||
token=$(curl -sX GET "https://ghcr.io/token?scope=repository%3Alinuxserver%2F${CONTAINER_NAME}%3Apull" | jq -r '.token')
|
||||
digest=$(curl -s \
|
||||
--header "Accept: application/vnd.docker.distribution.manifest.v2+json" \
|
||||
--header "Authorization: Bearer ${token}" \
|
||||
"https://ghcr.io/v2/linuxserver/${CONTAINER_NAME}/manifests/arm32v7-latest")
|
||||
if [[ $(echo "$digest" | jq -r '.layers') != "null" ]]; then
|
||||
docker manifest push --purge ${MANIFESTIMAGE}:arm32v7-latest || :
|
||||
docker manifest create ${MANIFESTIMAGE}:arm32v7-latest ${MANIFESTIMAGE}:amd64-latest
|
||||
docker manifest push --purge ${MANIFESTIMAGE}:arm32v7-latest
|
||||
fi
|
||||
docker manifest push --purge ${MANIFESTIMAGE}:latest
|
||||
docker manifest push --purge ${MANIFESTIMAGE}:${META_TAG}
|
||||
docker manifest push --purge ${MANIFESTIMAGE}:${EXT_RELEASE_TAG}
|
||||
if [ -n "${SEMVER}" ]; then
|
||||
docker manifest push --purge ${MANIFESTIMAGE}:${SEMVER}
|
||||
fi
|
||||
done
|
||||
docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:amd64-${META_TAG} -t ${MANIFESTIMAGE}:amd64-latest -t ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} || \
|
||||
{ if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; }
|
||||
docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:arm64v8-${META_TAG} -t ${MANIFESTIMAGE}:arm64v8-latest -t ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG} ${CACHEIMAGE}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} || \
|
||||
{ if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; }
|
||||
if [ -n "${SEMVER}" ]; then
|
||||
docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:amd64-${SEMVER} ${CACHEIMAGE}:amd64-${COMMIT_SHA}-${BUILD_NUMBER} || \
|
||||
{ if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; }
|
||||
docker buildx imagetools create --prefer-index=false -t ${MANIFESTIMAGE}:arm64v8-${SEMVER} ${CACHEIMAGE}:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER} || \
|
||||
{ if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; }
|
||||
fi
|
||||
done
|
||||
for MANIFESTIMAGE in "${IMAGE}" "${GITLABIMAGE}" "${GITHUBIMAGE}" "${QUAYIMAGE}"; do
|
||||
docker buildx imagetools create -t ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:amd64-latest ${MANIFESTIMAGE}:arm64v8-latest || \
|
||||
{ if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; }
|
||||
docker buildx imagetools create -t ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG} || \
|
||||
{ if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; }
|
||||
docker buildx imagetools create -t ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG} || \
|
||||
{ if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; }
|
||||
if [ -n "${SEMVER}" ]; then
|
||||
docker buildx imagetools create -t ${MANIFESTIMAGE}:${SEMVER} ${MANIFESTIMAGE}:amd64-${SEMVER} ${MANIFESTIMAGE}:arm64v8-${SEMVER} || \
|
||||
{ if [[ "${MANIFESTIMAGE}" != "${QUAYIMAGE}" ]]; then exit 1; fi; }
|
||||
fi
|
||||
done
|
||||
'''
|
||||
'''
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -1011,41 +841,23 @@ pipeline {
|
||||
environment name: 'EXIT_STATUS', value: ''
|
||||
}
|
||||
steps {
|
||||
echo "Pushing New tag for current commit ${META_TAG}"
|
||||
sh '''curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/git/tags \
|
||||
-d '{"tag":"'${META_TAG}'",\
|
||||
"object": "'${COMMIT_SHA}'",\
|
||||
"message": "Tagging Release '${EXT_RELEASE_CLEAN}'-ls'${LS_TAG_NUMBER}' to master",\
|
||||
"type": "commit",\
|
||||
"tagger": {"name": "LinuxServer Jenkins","email": "jenkins@linuxserver.io","date": "'${GITHUB_DATE}'"}}' '''
|
||||
echo "Pushing New release for Tag"
|
||||
sh '''#! /bin/bash
|
||||
echo "Auto-generating release notes"
|
||||
if [ "$(git tag --points-at HEAD)" != "" ]; then
|
||||
echo "Existing tag points to current commit, suggesting no new LS changes"
|
||||
AUTO_RELEASE_NOTES="No changes"
|
||||
else
|
||||
AUTO_RELEASE_NOTES=$(curl -fsL -H "Authorization: token ${GITHUB_TOKEN}" -H "Accept: application/vnd.github+json" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/releases/generate-notes \
|
||||
-d '{"tag_name":"'${META_TAG}'",\
|
||||
"target_commitish": "master"}' \
|
||||
| jq -r '.body' | sed 's|## What.s Changed||')
|
||||
fi
|
||||
echo "Pushing New tag for current commit ${META_TAG}"
|
||||
curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/git/tags \
|
||||
-d '{"tag":"'${META_TAG}'",\
|
||||
"object": "'${COMMIT_SHA}'",\
|
||||
"message": "Tagging Release '${EXT_RELEASE_CLEAN}'-ls'${LS_TAG_NUMBER}' to master",\
|
||||
"type": "commit",\
|
||||
"tagger": {"name": "LinuxServer-CI","email": "ci@linuxserver.io","date": "'${GITHUB_DATE}'"}}'
|
||||
echo "Pushing New release for Tag"
|
||||
curl -H "Authorization: token ${GITHUB_TOKEN}" -s https://api.github.com/repos/${EXT_USER}/${EXT_REPO}/releases/latest | jq -r '. |.body' > releasebody.json
|
||||
jq -n \
|
||||
--arg tag_name "$META_TAG" \
|
||||
--arg target_commitish "master" \
|
||||
--arg ci_url "${CI_URL:-N/A}" \
|
||||
--arg ls_notes "$AUTO_RELEASE_NOTES" \
|
||||
--arg remote_notes "$(cat releasebody.json)" \
|
||||
'{
|
||||
"tag_name": $tag_name,
|
||||
"target_commitish": $target_commitish,
|
||||
"name": $tag_name,
|
||||
"body": ("**CI Report:**\\n\\n" + $ci_url + "\\n\\n**LinuxServer Changes:**\\n\\n" + $ls_notes + "\\n\\n**Remote Changes:**\\n\\n" + $remote_notes),
|
||||
"draft": false,
|
||||
"prerelease": false }' > releasebody.json.done
|
||||
curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/releases -d @releasebody.json.done
|
||||
'''
|
||||
curl -H "Authorization: token ${GITHUB_TOKEN}" -s https://api.github.com/repos/${EXT_USER}/${EXT_REPO}/releases/latest | jq '. |.body' | sed 's:^.\\(.*\\).$:\\1:' > releasebody.json
|
||||
echo '{"tag_name":"'${META_TAG}'",\
|
||||
"target_commitish": "master",\
|
||||
"name": "'${META_TAG}'",\
|
||||
"body": "**LinuxServer Changes:**\\n\\n'${LS_RELEASE_NOTES}'\\n\\n**'${EXT_REPO}' Changes:**\\n\\n' > start
|
||||
printf '","draft": false,"prerelease": false}' >> releasebody.json
|
||||
paste -d'\\0' start releasebody.json > releasebody.json.done
|
||||
curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/releases -d @releasebody.json.done'''
|
||||
}
|
||||
}
|
||||
// Add protection to the release branch
|
||||
@ -1167,94 +979,32 @@ EOF
|
||||
###################### */
|
||||
post {
|
||||
always {
|
||||
sh '''#!/bin/bash
|
||||
rm -rf /config/.ssh/id_sign
|
||||
rm -rf /config/.ssh/id_sign.pub
|
||||
git config --global --unset gpg.format
|
||||
git config --global --unset user.signingkey
|
||||
git config --global --unset commit.gpgsign
|
||||
'''
|
||||
script{
|
||||
env.JOB_DATE = sh(
|
||||
script: '''date '+%Y-%m-%dT%H:%M:%S%:z' ''',
|
||||
returnStdout: true).trim()
|
||||
if (env.EXIT_STATUS == "ABORTED"){
|
||||
sh 'echo "build aborted"'
|
||||
}else{
|
||||
if (currentBuild.currentResult == "SUCCESS"){
|
||||
if (env.GITHUBIMAGE =~ /lspipepr/){
|
||||
env.JOB_WEBHOOK_STATUS='Success'
|
||||
env.JOB_WEBHOOK_COLOUR=3957028
|
||||
env.JOB_WEBHOOK_FOOTER='PR Build'
|
||||
}else if (env.GITHUBIMAGE =~ /lsiodev/){
|
||||
env.JOB_WEBHOOK_STATUS='Success'
|
||||
env.JOB_WEBHOOK_COLOUR=3957028
|
||||
env.JOB_WEBHOOK_FOOTER='Dev Build'
|
||||
}else{
|
||||
env.JOB_WEBHOOK_STATUS='Success'
|
||||
env.JOB_WEBHOOK_COLOUR=1681177
|
||||
env.JOB_WEBHOOK_FOOTER='Live Build'
|
||||
}
|
||||
}else{
|
||||
if (env.GITHUBIMAGE =~ /lspipepr/){
|
||||
env.JOB_WEBHOOK_STATUS='Failure'
|
||||
env.JOB_WEBHOOK_COLOUR=12669523
|
||||
env.JOB_WEBHOOK_FOOTER='PR Build'
|
||||
}else if (env.GITHUBIMAGE =~ /lsiodev/){
|
||||
env.JOB_WEBHOOK_STATUS='Failure'
|
||||
env.JOB_WEBHOOK_COLOUR=12669523
|
||||
env.JOB_WEBHOOK_FOOTER='Dev Build'
|
||||
}else{
|
||||
env.JOB_WEBHOOK_STATUS='Failure'
|
||||
env.JOB_WEBHOOK_COLOUR=16711680
|
||||
env.JOB_WEBHOOK_FOOTER='Live Build'
|
||||
}
|
||||
}
|
||||
sh ''' curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/jenkins-avatar.png","embeds": [{"'color'": '${JOB_WEBHOOK_COLOUR}',\
|
||||
"footer": {"text" : "'"${JOB_WEBHOOK_FOOTER}"'"},\
|
||||
"timestamp": "'${JOB_DATE}'",\
|
||||
"description": "**Build:** '${BUILD_NUMBER}'\\n**CI Results:** '${CI_URL}'\\n**ShellCheck Results:** '${SHELLCHECK_URL}'\\n**Status:** '${JOB_WEBHOOK_STATUS}'\\n**Job:** '${RUN_DISPLAY_URL}'\\n**Change:** '${CODE_URL}'\\n**External Release:**: '${RELEASE_LINK}'\\n**DockerHub:** '${DOCKERHUB_LINK}'\\n"}],\
|
||||
}
|
||||
else if (currentBuild.currentResult == "SUCCESS"){
|
||||
sh ''' curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/jenkins-avatar.png","embeds": [{"color": 1681177,\
|
||||
"description": "**Build:** '${BUILD_NUMBER}'\\n**CI Results:** '${CI_URL}'\\n**ShellCheck Results:** '${SHELLCHECK_URL}'\\n**Status:** Success\\n**Job:** '${RUN_DISPLAY_URL}'\\n**Change:** '${CODE_URL}'\\n**External Release:**: '${RELEASE_LINK}'\\n**DockerHub:** '${DOCKERHUB_LINK}'\\n"}],\
|
||||
"username": "Jenkins"}' ${BUILDS_DISCORD} '''
|
||||
}
|
||||
else {
|
||||
sh ''' curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/jenkins-avatar.png","embeds": [{"color": 16711680,\
|
||||
"description": "**Build:** '${BUILD_NUMBER}'\\n**CI Results:** '${CI_URL}'\\n**ShellCheck Results:** '${SHELLCHECK_URL}'\\n**Status:** failure\\n**Job:** '${RUN_DISPLAY_URL}'\\n**Change:** '${CODE_URL}'\\n**External Release:**: '${RELEASE_LINK}'\\n**DockerHub:** '${DOCKERHUB_LINK}'\\n"}],\
|
||||
"username": "Jenkins"}' ${BUILDS_DISCORD} '''
|
||||
}
|
||||
}
|
||||
}
|
||||
cleanup {
|
||||
sh '''#! /bin/bash
|
||||
echo "Pruning builder!!"
|
||||
docker builder prune -f --builder container || :
|
||||
containers=$(docker ps -q)
|
||||
echo "Performing docker system prune!!"
|
||||
containers=$(docker ps -aq)
|
||||
if [[ -n "${containers}" ]]; then
|
||||
BUILDX_CONTAINER_ID=$(docker ps -qf 'name=buildx_buildkit')
|
||||
for container in ${containers}; do
|
||||
if [[ "${container}" == "${BUILDX_CONTAINER_ID}" ]]; then
|
||||
echo "skipping buildx container in docker stop"
|
||||
else
|
||||
echo "Stopping container ${container}"
|
||||
docker stop ${container}
|
||||
fi
|
||||
done
|
||||
docker stop ${containers}
|
||||
fi
|
||||
docker system prune -f --volumes || :
|
||||
docker image prune -af || :
|
||||
docker system prune -af --volumes || :
|
||||
'''
|
||||
cleanWs()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
def retry_backoff(int max_attempts, int power_base, Closure c) {
|
||||
int n = 0
|
||||
while (n < max_attempts) {
|
||||
try {
|
||||
c()
|
||||
return
|
||||
} catch (err) {
|
||||
if ((n + 1) >= max_attempts) {
|
||||
throw err
|
||||
}
|
||||
sleep(power_base ** n)
|
||||
n++
|
||||
}
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
123
README.md
123
README.md
@ -3,8 +3,9 @@
|
||||
[](https://linuxserver.io)
|
||||
|
||||
[](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
|
||||
[](https://linuxserver.io/discord "realtime support / chat with the community and the team.")
|
||||
[](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.")
|
||||
[](https://discourse.linuxserver.io "post on our community forum.")
|
||||
[](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
|
||||
[](https://github.com/linuxserver "view the source for all of our repositories.")
|
||||
[](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
|
||||
|
||||
@ -19,14 +20,15 @@ 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://linuxserver.io/discord) - realtime support / chat with the community and the team.
|
||||
* [Discord](https://discord.gg/YWrKVTn) - 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)
|
||||
|
||||
[](https://scarf.sh)
|
||||
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fbookstack)
|
||||
[](https://github.com/linuxserver/docker-bookstack)
|
||||
[](https://github.com/linuxserver/docker-bookstack/releases)
|
||||
[](https://github.com/linuxserver/docker-bookstack/packages)
|
||||
@ -35,6 +37,7 @@ Find us at:
|
||||
[](https://hub.docker.com/r/linuxserver/bookstack)
|
||||
[](https://hub.docker.com/r/linuxserver/bookstack)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/)
|
||||
[](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. Featuring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
|
||||
|
||||
@ -42,7 +45,7 @@ Powered by SQL and including a Markdown editor for those who prefer it, BookStac
|
||||
|
||||
For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
|
||||
|
||||
[](https://github.com/BookStackApp/BookStack)
|
||||
[](https://github.com/BookStackApp/BookStack)
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
@ -56,86 +59,81 @@ The architectures supported by this image are:
|
||||
| :----: | :----: | ---- |
|
||||
| x86-64 | ✅ | amd64-\<version tag\> |
|
||||
| arm64 | ✅ | arm64v8-\<version tag\> |
|
||||
| armhf | ❌ | |
|
||||
|
||||
## Application Setup
|
||||
|
||||
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 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.
|
||||
|
||||
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/laravel.log` => `storage/logs/laravel.log`
|
||||
- `/config/www/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.
|
||||
|
||||
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.
|
||||
|
||||
## 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
|
||||
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.
|
||||
|
||||
## Usage
|
||||
|
||||
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: lscr.io/linuxserver/bookstack:latest
|
||||
image: lscr.io/linuxserver/bookstack
|
||||
container_name: bookstack
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- TZ=Etc/UTC
|
||||
- APP_URL=
|
||||
- APP_KEY=
|
||||
- DB_HOST=
|
||||
- APP_URL=https://bookstack.example.com
|
||||
- DB_HOST=bookstack_db
|
||||
- DB_PORT=3306
|
||||
- DB_USERNAME=
|
||||
- DB_PASSWORD=
|
||||
- DB_DATABASE=
|
||||
- QUEUE_CONNECTION= #optional
|
||||
- DB_USER=bookstack
|
||||
- DB_PASS=<yourdbpass>
|
||||
- DB_DATABASE=bookstackapp
|
||||
volumes:
|
||||
- /path/to/bookstack/config:/config
|
||||
- ./bookstack_app_data:/config
|
||||
ports:
|
||||
- 6875:80
|
||||
restart: unless-stopped
|
||||
depends_on:
|
||||
- bookstack_db
|
||||
bookstack_db:
|
||||
image: lscr.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:
|
||||
- ./bookstack_db_data:/config
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
||||
@ -146,13 +144,12 @@ docker run -d \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
-e TZ=Etc/UTC \
|
||||
-e APP_URL= \
|
||||
-e APP_KEY= \
|
||||
-e DB_HOST= \
|
||||
-e DB_PORT=3306 \
|
||||
-e DB_USERNAME= \
|
||||
-e DB_PASSWORD= \
|
||||
-e DB_DATABASE= \
|
||||
-e APP_URL=yourbaseurl \
|
||||
-e DB_HOST=yourdbhost \
|
||||
-e DB_PORT=yourdbport \
|
||||
-e DB_USER=yourdbuser \
|
||||
-e DB_PASS=yourdbpass \
|
||||
-e DB_DATABASE=bookstackapp \
|
||||
-e QUEUE_CONNECTION= `#optional` \
|
||||
-p 6875:80 \
|
||||
-v /path/to/bookstack/config:/config \
|
||||
@ -166,20 +163,18 @@ Containers are configured using parameters passed at runtime (such as those abov
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| `-p 6875:80` | http/s web interface. |
|
||||
| `-p 80` | will map the container's port 80 to port 6875 on the host |
|
||||
| `-e PUID=1000` | for UserID - see below for explanation |
|
||||
| `-e PGID=1000` | for GroupID - see below for explanation |
|
||||
| `-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 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 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_HOST=` | The database instance hostname |
|
||||
| `-e DB_PORT=3306` | Database port |
|
||||
| `-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 APP_URL=yourbaseurl` | 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 DB_HOST=yourdbhost` | for specifying the database host |
|
||||
| `-e DB_PORT=yourdbport` | for specifying the database port if not default 3306 |
|
||||
| `-e DB_USER=yourdbuser` | for specifying the database user |
|
||||
| `-e DB_PASS=yourdbpass` | for specifying the database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.) |
|
||||
| `-e DB_DATABASE=bookstackapp` | for specifying the database to be used |
|
||||
| `-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)
|
||||
|
||||
@ -317,8 +312,7 @@ Below are the instructions for updating containers:
|
||||
|
||||
### Image Update Notifications - Diun (Docker Image Update Notifier)
|
||||
|
||||
>[!TIP]
|
||||
>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
|
||||
|
||||
@ -333,23 +327,16 @@ docker build \
|
||||
-t lscr.io/linuxserver/bookstack:latest .
|
||||
```
|
||||
|
||||
The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
|
||||
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
|
||||
|
||||
```bash
|
||||
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
|
||||
docker run --rm --privileged multiarch/qemu-user-static:register --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.
|
||||
|
||||
@ -6,6 +6,7 @@ external_type: github_stable
|
||||
release_type: stable
|
||||
release_tag: latest
|
||||
ls_branch: master
|
||||
build_armhf: false
|
||||
repo_vars:
|
||||
- EXT_GIT_BRANCH = 'master'
|
||||
- EXT_USER = 'bookstackapp'
|
||||
@ -19,11 +20,11 @@ repo_vars:
|
||||
- PR_DOCKERHUB_IMAGE = 'lspipepr/bookstack'
|
||||
- DIST_IMAGE = 'alpine'
|
||||
- MULTIARCH = 'true'
|
||||
- CI = 'false'
|
||||
- CI = 'true'
|
||||
- CI_WEB = 'false'
|
||||
- CI_PORT = '80'
|
||||
- CI_SSL = 'false'
|
||||
- CI_DELAY = '60'
|
||||
- CI_DOCKERENV=''
|
||||
- CI_AUTH = ''
|
||||
- CI_DELAY = '30'
|
||||
- CI_DOCKERENV='TEST_RUN=1'
|
||||
- CI_AUTH = 'user:password'
|
||||
- CI_WEBPATH = ''
|
||||
|
||||
@ -1,296 +1,292 @@
|
||||
NAME VERSION TYPE
|
||||
Hidden Input 1, 0, 0, 0 binary
|
||||
acl-libs 2.3.2-r1 apk
|
||||
alpine-baselayout 3.7.1-r8 apk
|
||||
alpine-baselayout-data 3.7.1-r8 apk
|
||||
alpine-keys 2.6-r0 apk
|
||||
alpine-release 3.23.3-r0 apk
|
||||
aom-libs 3.13.1-r1 apk
|
||||
apache2-utils 2.4.66-r0 apk
|
||||
apk-tools 3.0.4-r0 apk
|
||||
apr 1.7.6-r0 apk
|
||||
apr-util 1.6.3-r2 apk
|
||||
Hidden Input 1, 0, 0, 0 dotnet
|
||||
alpine-baselayout 3.4.3-r2 apk
|
||||
alpine-baselayout-data 3.4.3-r2 apk
|
||||
alpine-keys 2.4-r1 apk
|
||||
alpine-release 3.19.1-r0 apk
|
||||
aom-libs 3.7.1-r0 apk
|
||||
apache2-utils 2.4.58-r1 apk
|
||||
apk-tools 2.14.0-r5 apk
|
||||
apr 1.7.4-r0 apk
|
||||
apr-util 1.6.3-r1 apk
|
||||
argon2-libs 20190702-r5 apk
|
||||
aws/aws-crt-php v1.2.7 php-composer
|
||||
aws/aws-sdk-php 3.369.36 php-composer
|
||||
bacon/bacon-qr-code v3.0.3 php-composer
|
||||
bash 5.3.3-r1 apk
|
||||
brick/math 0.14.8 php-composer
|
||||
brotli-libs 1.2.0-r0 apk
|
||||
busybox 1.37.0-r30 apk
|
||||
busybox-binsh 1.37.0-r30 apk
|
||||
c-ares 1.34.6-r0 apk
|
||||
ca-certificates 20251003-r0 apk
|
||||
ca-certificates-bundle 20251003-r0 apk
|
||||
carbonphp/carbon-doctrine-types 3.2.0 php-composer
|
||||
catatonit 0.2.1-r0 apk
|
||||
composer 2.9.5 binary
|
||||
coreutils 9.8-r1 apk
|
||||
coreutils-env 9.8-r1 apk
|
||||
coreutils-fmt 9.8-r1 apk
|
||||
coreutils-sha512sum 9.8-r1 apk
|
||||
curl 8.17.0-r1 apk
|
||||
dasprid/enum 1.0.7 php-composer
|
||||
dbus-libs 1.16.2-r1 apk
|
||||
dflydev/dot-access-data v3.0.3 php-composer
|
||||
doctrine/inflector 2.1.0 php-composer
|
||||
doctrine/lexer 3.0.1 php-composer
|
||||
dompdf/dompdf v3.1.4 php-composer
|
||||
dompdf/php-font-lib 1.0.2 php-composer
|
||||
dompdf/php-svg-lib 1.0.2 php-composer
|
||||
dragonmantank/cron-expression v3.6.0 php-composer
|
||||
egulias/email-validator 4.0.4 php-composer
|
||||
encodings 1.1.0-r0 apk
|
||||
ezyang/htmlpurifier v4.19.0 php-composer
|
||||
fakerphp/faker v1.24.1 php-composer
|
||||
filp/whoops 2.18.4 php-composer
|
||||
findutils 4.10.0-r0 apk
|
||||
firebase/php-jwt v7.0.2 php-composer
|
||||
aws/aws-crt-php v1.2.4 php-composer
|
||||
aws/aws-sdk-php 3.300.6 php-composer
|
||||
bacon/bacon-qr-code 2.0.8 php-composer
|
||||
barryvdh/laravel-dompdf v2.0.1 php-composer
|
||||
barryvdh/laravel-snappy v1.0.2 php-composer
|
||||
bash 5.2.21-r0 apk
|
||||
brick/math 0.11.0 php-composer
|
||||
brotli-libs 1.1.0-r1 apk
|
||||
busybox 1.36.1-r15 apk
|
||||
busybox-binsh 1.36.1-r15 apk
|
||||
c-ares 1.24.0-r1 apk
|
||||
ca-certificates 20230506-r0 apk
|
||||
ca-certificates-bundle 20230506-r0 apk
|
||||
carbonphp/carbon-doctrine-types 2.1.0 php-composer
|
||||
composer 2.7.1 binary
|
||||
coreutils 9.4-r2 apk
|
||||
coreutils-env 9.4-r2 apk
|
||||
coreutils-fmt 9.4-r2 apk
|
||||
coreutils-sha512sum 9.4-r2 apk
|
||||
curl 8.5.0-r0 apk
|
||||
dasprid/enum 1.0.5 php-composer
|
||||
dbus-libs 1.14.10-r0 apk
|
||||
dflydev/dot-access-data v3.0.2 php-composer
|
||||
doctrine/cache 2.2.0 php-composer
|
||||
doctrine/dbal 3.8.2 php-composer
|
||||
doctrine/deprecations 1.1.3 php-composer
|
||||
doctrine/event-manager 1.2.0 php-composer
|
||||
doctrine/inflector 2.0.10 php-composer
|
||||
doctrine/instantiator 1.5.0 php-composer
|
||||
doctrine/lexer 2.1.1 php-composer
|
||||
dompdf/dompdf v2.0.4 php-composer
|
||||
dragonmantank/cron-expression v3.3.3 php-composer
|
||||
egulias/email-validator 3.2.6 php-composer
|
||||
encodings 1.0.7-r1 apk
|
||||
fakerphp/faker v1.23.1 php-composer
|
||||
filp/whoops 2.15.4 php-composer
|
||||
font-freefont 20120503-r4 apk
|
||||
fontconfig 2.17.1-r0 apk
|
||||
freetype 2.14.1-r0 apk
|
||||
fruitcake/php-cors v1.4.0 php-composer
|
||||
gdbm 1.26-r0 apk
|
||||
git 2.52.0-r0 apk
|
||||
git-init-template 2.52.0-r0 apk
|
||||
glib 2.86.3-r0 apk
|
||||
graham-campbell/result-type v1.1.4 php-composer
|
||||
guzzlehttp/guzzle 7.10.0 php-composer
|
||||
guzzlehttp/promises 2.3.0 php-composer
|
||||
guzzlehttp/psr7 2.8.0 php-composer
|
||||
guzzlehttp/uri-template v1.0.5 php-composer
|
||||
hamcrest/hamcrest-php v2.1.1 php-composer
|
||||
iamcal/sql-parser v0.7 php-composer
|
||||
icu-data-full 76.1-r1 apk
|
||||
icu-libs 76.1-r1 apk
|
||||
intervention/gif 4.2.4 php-composer
|
||||
intervention/image 3.11.6 php-composer
|
||||
itsgoingd/clockwork v5.3.5 php-composer
|
||||
jq 1.8.1-r0 apk
|
||||
knplabs/knp-snappy v1.6.0 php-composer
|
||||
larastan/larastan v3.9.2 php-composer
|
||||
laravel/framework v12.52.0 php-composer
|
||||
laravel/prompts v0.3.13 php-composer
|
||||
laravel/serializable-closure v2.0.9 php-composer
|
||||
laravel/socialite v5.24.2 php-composer
|
||||
laravel/tinker v2.11.1 php-composer
|
||||
league/commonmark 2.8.0 php-composer
|
||||
fontconfig 2.14.2-r4 apk
|
||||
freetype 2.13.2-r0 apk
|
||||
fruitcake/php-cors v1.3.0 php-composer
|
||||
gdbm 1.23-r1 apk
|
||||
git 2.43.0-r0 apk
|
||||
git-perl 2.43.0-r0 apk
|
||||
glib 2.78.4-r0 apk
|
||||
graham-campbell/result-type v1.1.2 php-composer
|
||||
guzzlehttp/guzzle 7.8.1 php-composer
|
||||
guzzlehttp/promises 2.0.2 php-composer
|
||||
guzzlehttp/psr7 2.6.2 php-composer
|
||||
guzzlehttp/uri-template v1.0.3 php-composer
|
||||
hamcrest/hamcrest-php v2.0.1 php-composer
|
||||
hiredis 1.2.0-r0 apk
|
||||
icu-data-full 74.1-r0 apk
|
||||
icu-libs 74.1-r0 apk
|
||||
intervention/image 2.7.2 php-composer
|
||||
itsgoingd/clockwork v5.2.0 php-composer
|
||||
jq 1.7.1-r0 apk
|
||||
knplabs/knp-snappy v1.4.4 php-composer
|
||||
larastan/larastan v2.9.1 php-composer
|
||||
laravel/framework v9.52.16 php-composer
|
||||
laravel/serializable-closure v1.3.3 php-composer
|
||||
laravel/socialite v5.12.1 php-composer
|
||||
laravel/tinker v2.9.0 php-composer
|
||||
league/commonmark 2.4.2 php-composer
|
||||
league/config v1.2.0 php-composer
|
||||
league/flysystem 3.31.0 php-composer
|
||||
league/flysystem-aws-s3-v3 3.31.0 php-composer
|
||||
league/flysystem-local 3.31.0 php-composer
|
||||
league/flysystem 3.24.0 php-composer
|
||||
league/flysystem-aws-s3-v3 3.24.0 php-composer
|
||||
league/flysystem-local 3.23.1 php-composer
|
||||
league/html-to-markdown 5.1.1 php-composer
|
||||
league/mime-type-detection 1.16.0 php-composer
|
||||
league/oauth1-client v1.11.0 php-composer
|
||||
league/oauth2-client 2.9.0 php-composer
|
||||
league/uri 7.8.0 php-composer
|
||||
league/uri-interfaces 7.8.0 php-composer
|
||||
libapk 3.0.4-r0 apk
|
||||
libattr 2.5.2-r2 apk
|
||||
libavif 1.3.0-r0 apk
|
||||
libblkid 2.41.2-r0 apk
|
||||
libbsd 0.12.2-r0 apk
|
||||
league/mime-type-detection 1.15.0 php-composer
|
||||
league/oauth1-client v1.10.1 php-composer
|
||||
league/oauth2-client 2.7.0 php-composer
|
||||
libacl 2.3.1-r4 apk
|
||||
libattr 2.5.1-r5 apk
|
||||
libavif 1.0.3-r0 apk
|
||||
libblkid 2.39.3-r0 apk
|
||||
libbsd 0.11.7-r3 apk
|
||||
libbz2 1.0.8-r6 apk
|
||||
libcrypto3 3.5.5-r0 apk
|
||||
libcurl 8.17.0-r1 apk
|
||||
libdav1d 1.5.2-r0 apk
|
||||
libeconf 0.8.3-r0 apk
|
||||
libedit 20251016.3.1-r0 apk
|
||||
libevent 2.1.12-r8 apk
|
||||
libexpat 2.7.4-r0 apk
|
||||
libffi 3.5.2-r0 apk
|
||||
libfontenc 1.1.8-r0 apk
|
||||
libgcc 15.2.0-r2 apk
|
||||
libice 1.1.2-r0 apk
|
||||
libidn2 2.3.8-r0 apk
|
||||
libintl 0.24.1-r1 apk
|
||||
libjpeg-turbo 3.1.2-r0 apk
|
||||
libldap 2.6.10-r0 apk
|
||||
libc-utils 0.7.2-r5 apk
|
||||
libcrypto3 3.1.4-r5 apk
|
||||
libcurl 8.5.0-r0 apk
|
||||
libdav1d 1.3.0-r1 apk
|
||||
libedit 20230828.3.1-r3 apk
|
||||
libevent 2.1.12-r7 apk
|
||||
libexpat 2.6.0-r0 apk
|
||||
libffi 3.4.4-r3 apk
|
||||
libfontenc 1.1.7-r4 apk
|
||||
libgcc 13.2.1_git20231014-r0 apk
|
||||
libice 1.1.1-r5 apk
|
||||
libidn2 2.3.4-r4 apk
|
||||
libintl 0.22.3-r0 apk
|
||||
libjpeg-turbo 3.0.1-r0 apk
|
||||
libldap 2.6.6-r1 apk
|
||||
libmd 1.1.0-r0 apk
|
||||
libmemcached-libs 1.1.4-r1 apk
|
||||
libmount 2.41.2-r0 apk
|
||||
libncursesw 6.5_p20251123-r0 apk
|
||||
libpcre2-16 10.47-r0 apk
|
||||
libpng 1.6.54-r0 apk
|
||||
libproc2 4.0.5-r0 apk
|
||||
libpsl 0.21.5-r3 apk
|
||||
libsasl 2.1.28-r9 apk
|
||||
libseccomp 2.6.0-r1 apk
|
||||
libsharpyuv 1.6.0-r0 apk
|
||||
libsm 1.2.6-r0 apk
|
||||
libssl3 3.5.5-r0 apk
|
||||
libstdc++ 15.2.0-r2 apk
|
||||
libunistring 1.4.1-r0 apk
|
||||
libuuid 2.41.2-r0 apk
|
||||
libwebp 1.6.0-r0 apk
|
||||
libx11 1.8.12-r1 apk
|
||||
libxau 1.0.12-r0 apk
|
||||
libxcb 1.17.0-r1 apk
|
||||
libxdmcp 1.1.5-r1 apk
|
||||
libxext 1.3.6-r2 apk
|
||||
libxml2 2.13.9-r0 apk
|
||||
libmount 2.39.3-r0 apk
|
||||
libncursesw 6.4_p20231125-r0 apk
|
||||
libpcre2-16 10.42-r2 apk
|
||||
libpng 1.6.40-r0 apk
|
||||
libproc2 4.0.4-r0 apk
|
||||
libsasl 2.1.28-r5 apk
|
||||
libseccomp 2.5.5-r0 apk
|
||||
libsharpyuv 1.3.2-r0 apk
|
||||
libsm 1.2.4-r3 apk
|
||||
libssl3 3.1.4-r5 apk
|
||||
libstdc++ 13.2.1_git20231014-r0 apk
|
||||
libunistring 1.1-r2 apk
|
||||
libuuid 2.39.3-r0 apk
|
||||
libwebp 1.3.2-r0 apk
|
||||
libx11 1.8.7-r0 apk
|
||||
libxau 1.0.11-r3 apk
|
||||
libxcb 1.16-r0 apk
|
||||
libxdmcp 1.1.4-r3 apk
|
||||
libxext 1.3.5-r3 apk
|
||||
libxml2 2.11.7-r0 apk
|
||||
libxpm 3.5.17-r0 apk
|
||||
libxt 1.3.1-r0 apk
|
||||
libyuv 0.0.1887.20251502-r1 apk
|
||||
libzip 1.11.4-r1 apk
|
||||
linux-pam 1.7.1-r2 apk
|
||||
logrotate 3.22.0-r0 apk
|
||||
mariadb-client 11.4.9-r0 apk
|
||||
mariadb-common 11.4.9-r0 apk
|
||||
masterminds/html5 2.10.0 php-composer
|
||||
memcached 1.6.39-r0 apk
|
||||
mkfontscale 1.2.3-r1 apk
|
||||
mockery/mockery 1.6.12 php-composer
|
||||
monolog/monolog 3.10.0 php-composer
|
||||
mtdowling/jmespath.php 2.8.0 php-composer
|
||||
musl 1.2.5-r21 apk
|
||||
musl-utils 1.2.5-r21 apk
|
||||
myclabs/deep-copy 1.13.4 php-composer
|
||||
nano 8.7-r0 apk
|
||||
ncurses-terminfo-base 6.5_p20251123-r0 apk
|
||||
nesbot/carbon 3.11.1 php-composer
|
||||
netcat-openbsd 1.234.1-r0 apk
|
||||
nette/schema v1.3.4 php-composer
|
||||
nette/utils v4.1.3 php-composer
|
||||
nghttp2-libs 1.68.0-r0 apk
|
||||
nghttp3 1.13.1-r0 apk
|
||||
nginx 1.28.2-r0 apk
|
||||
nikic/php-parser v5.7.0 php-composer
|
||||
nunomaduro/collision v8.9.1 php-composer
|
||||
nunomaduro/termwind v2.4.0 php-composer
|
||||
onelogin/php-saml 4.3.1 php-composer
|
||||
oniguruma 6.9.10-r0 apk
|
||||
openssl 3.5.5-r0 apk
|
||||
paragonie/constant_time_encoding v3.1.3 php-composer
|
||||
libxt 1.3.0-r4 apk
|
||||
libzip 1.10.1-r0 apk
|
||||
linux-pam 1.5.3-r7 apk
|
||||
logrotate 3.21.0-r1 apk
|
||||
mariadb-client 10.11.6-r0 apk
|
||||
mariadb-common 10.11.6-r0 apk
|
||||
masterminds/html5 2.8.1 php-composer
|
||||
memcached 1.6.22-r0 apk
|
||||
mkfontscale 1.2.2-r4 apk
|
||||
mockery/mockery 1.6.7 php-composer
|
||||
monolog/monolog 2.9.2 php-composer
|
||||
mtdowling/jmespath.php 2.7.0 php-composer
|
||||
musl 1.2.4_git20230717-r4 apk
|
||||
musl-utils 1.2.4_git20230717-r4 apk
|
||||
myclabs/deep-copy 1.11.1 php-composer
|
||||
nano 7.2-r1 apk
|
||||
ncurses-terminfo-base 6.4_p20231125-r0 apk
|
||||
nesbot/carbon 2.72.3 php-composer
|
||||
netcat-openbsd 1.226-r0 apk
|
||||
nette/schema v1.2.5 php-composer
|
||||
nette/utils v4.0.4 php-composer
|
||||
nghttp2-libs 1.58.0-r0 apk
|
||||
nginx 1.24.0-r15 apk
|
||||
nikic/php-parser v5.0.1 php-composer
|
||||
nunomaduro/collision v6.4.0 php-composer
|
||||
nunomaduro/termwind v1.15.1 php-composer
|
||||
onelogin/php-saml 4.1.0 php-composer
|
||||
oniguruma 6.9.9-r0 apk
|
||||
openssl 3.1.4-r5 apk
|
||||
paragonie/constant_time_encoding v2.6.3 php-composer
|
||||
paragonie/random_compat v9.99.100 php-composer
|
||||
pcre2 10.47-r0 apk
|
||||
phar-io/manifest 2.0.4 php-composer
|
||||
pcre 8.45-r3 apk
|
||||
pcre2 10.42-r2 apk
|
||||
perl 5.38.2-r0 apk
|
||||
perl-error 0.17029-r2 apk
|
||||
perl-git 2.43.0-r0 apk
|
||||
phar-io/manifest 2.0.3 php-composer
|
||||
phar-io/version 3.2.1 php-composer
|
||||
php85 8.5.2-r0 apk
|
||||
php85-common 8.5.2-r0 apk
|
||||
php85-ctype 8.5.2-r0 apk
|
||||
php85-curl 8.5.2-r0 apk
|
||||
php85-dom 8.5.2-r0 apk
|
||||
php85-exif 8.5.2-r0 apk
|
||||
php85-fileinfo 8.5.2-r0 apk
|
||||
php85-fpm 8.5.2-r0 apk
|
||||
php85-gd 8.5.2-r0 apk
|
||||
php85-iconv 8.5.2-r0 apk
|
||||
php85-ldap 8.5.2-r0 apk
|
||||
php85-mbstring 8.5.2-r0 apk
|
||||
php85-mysqlnd 8.5.2-r0 apk
|
||||
php85-openssl 8.5.2-r0 apk
|
||||
php85-pdo 8.5.2-r0 apk
|
||||
php85-pdo_mysql 8.5.2-r0 apk
|
||||
php85-pecl-igbinary 3.2.17_rc1-r0 apk
|
||||
php85-pecl-memcached 3.4.0-r0 apk
|
||||
php85-pecl-msgpack 3.0.0-r0 apk
|
||||
php85-phar 8.5.2-r0 apk
|
||||
php85-session 8.5.2-r0 apk
|
||||
php85-simplexml 8.5.2-r0 apk
|
||||
php85-sockets 8.5.2-r0 apk
|
||||
php85-tokenizer 8.5.2-r0 apk
|
||||
php85-xml 8.5.2-r0 apk
|
||||
php85-xmlwriter 8.5.2-r0 apk
|
||||
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
|
||||
phenx/php-font-lib 0.5.6 php-composer
|
||||
phenx/php-svg-lib 0.5.2 php-composer
|
||||
php83 8.3.3-r0 apk
|
||||
php83-common 8.3.3-r0 apk
|
||||
php83-ctype 8.3.3-r0 apk
|
||||
php83-curl 8.3.3-r0 apk
|
||||
php83-dom 8.3.3-r0 apk
|
||||
php83-fileinfo 8.3.3-r0 apk
|
||||
php83-fpm 8.3.3-r0 apk
|
||||
php83-gd 8.3.3-r0 apk
|
||||
php83-iconv 8.3.3-r0 apk
|
||||
php83-ldap 8.3.3-r0 apk
|
||||
php83-mbstring 8.3.3-r0 apk
|
||||
php83-mysqlnd 8.3.3-r0 apk
|
||||
php83-openssl 8.3.3-r0 apk
|
||||
php83-pdo 8.3.3-r0 apk
|
||||
php83-pdo_mysql 8.3.3-r0 apk
|
||||
php83-pecl-igbinary 3.2.15-r0 apk
|
||||
php83-pecl-memcached 3.2.0-r0 apk
|
||||
php83-pecl-msgpack 2.2.0-r1 apk
|
||||
php83-phar 8.3.3-r0 apk
|
||||
php83-session 8.3.3-r0 apk
|
||||
php83-simplexml 8.3.3-r0 apk
|
||||
php83-sockets 8.3.3-r0 apk
|
||||
php83-tokenizer 8.3.3-r0 apk
|
||||
php83-xml 8.3.3-r0 apk
|
||||
php83-xmlwriter 8.3.3-r0 apk
|
||||
php83-zip 8.3.3-r0 apk
|
||||
phpmyadmin/sql-parser 5.9.0 php-composer
|
||||
phpoption/phpoption 1.9.2 php-composer
|
||||
phpseclib/phpseclib 3.0.36 php-composer
|
||||
phpstan/phpstan 1.10.59 php-composer
|
||||
phpunit/php-code-coverage 9.2.30 php-composer
|
||||
phpunit/php-file-iterator 3.0.6 php-composer
|
||||
phpunit/php-invoker 3.1.1 php-composer
|
||||
phpunit/php-text-template 2.0.4 php-composer
|
||||
phpunit/php-timer 5.0.3 php-composer
|
||||
phpunit/phpunit 9.6.17 php-composer
|
||||
popt 1.19-r3 apk
|
||||
pragmarx/google2fa v8.0.1 php-composer
|
||||
predis/predis v2.2.2 php-composer
|
||||
procps-ng 4.0.4-r0 apk
|
||||
psr/cache 3.0.0 php-composer
|
||||
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-factory 1.0.2 php-composer
|
||||
psr/http-message 2.0 php-composer
|
||||
psr/log 3.0.2 php-composer
|
||||
psr/log 3.0.0 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
|
||||
psy/psysh v0.12.0 php-composer
|
||||
qt5-qtbase 5.15.10_git20230714-r2 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
|
||||
ramsey/collection 1.3.0 php-composer
|
||||
ramsey/uuid 4.7.5 php-composer
|
||||
readline 8.2.1-r2 apk
|
||||
robrichards/xmlseclibs 3.1.1 php-composer
|
||||
sabberworm/php-css-parser v8.5.1 php-composer
|
||||
scanelf 1.3.7-r2 apk
|
||||
sebastian/cli-parser 1.0.1 php-composer
|
||||
sebastian/code-unit 1.0.8 php-composer
|
||||
sebastian/code-unit-reverse-lookup 2.0.3 php-composer
|
||||
sebastian/comparator 4.0.8 php-composer
|
||||
sebastian/complexity 2.0.3 php-composer
|
||||
sebastian/diff 4.0.5 php-composer
|
||||
sebastian/environment 5.1.5 php-composer
|
||||
sebastian/exporter 4.0.5 php-composer
|
||||
sebastian/global-state 5.0.6 php-composer
|
||||
sebastian/lines-of-code 1.0.4 php-composer
|
||||
sebastian/object-enumerator 4.0.4 php-composer
|
||||
sebastian/object-reflector 2.0.4 php-composer
|
||||
sebastian/recursion-context 4.0.5 php-composer
|
||||
sebastian/resource-operations 3.0.3 php-composer
|
||||
sebastian/type 3.2.1 php-composer
|
||||
sebastian/version 3.0.2 php-composer
|
||||
shadow 4.14.2-r0 apk
|
||||
skalibs 2.14.0.1-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
|
||||
socialiteproviders/manager v4.5.1 php-composer
|
||||
socialiteproviders/microsoft-azure 5.1.0 php-composer
|
||||
socialiteproviders/okta 4.4.0 php-composer
|
||||
socialiteproviders/twitch 5.3.1 php-composer
|
||||
squizlabs/php_codesniffer 3.9.0 php-composer
|
||||
ssddanbrown/asserthtml v2.0.0 php-composer
|
||||
ssddanbrown/htmldiff v1.0.2 php-composer
|
||||
ssddanbrown/symfony-mailer 6.0.x-dev php-composer
|
||||
ssl_client 1.36.1-r15 apk
|
||||
symfony/console v6.0.19 php-composer
|
||||
symfony/css-selector v6.0.19 php-composer
|
||||
symfony/deprecation-contracts v3.0.2 php-composer
|
||||
symfony/dom-crawler v6.0.19 php-composer
|
||||
symfony/error-handler v6.0.19 php-composer
|
||||
symfony/event-dispatcher v6.0.19 php-composer
|
||||
symfony/event-dispatcher-contracts v3.0.2 php-composer
|
||||
symfony/finder v6.0.19 php-composer
|
||||
symfony/http-foundation v6.0.20 php-composer
|
||||
symfony/http-kernel v6.0.20 php-composer
|
||||
symfony/mime v6.0.19 php-composer
|
||||
symfony/polyfill-ctype v1.29.0 php-composer
|
||||
symfony/polyfill-intl-grapheme v1.29.0 php-composer
|
||||
symfony/polyfill-intl-idn v1.29.0 php-composer
|
||||
symfony/polyfill-intl-normalizer v1.29.0 php-composer
|
||||
symfony/polyfill-mbstring v1.29.0 php-composer
|
||||
symfony/polyfill-php72 v1.29.0 php-composer
|
||||
symfony/polyfill-php80 v1.29.0 php-composer
|
||||
symfony/polyfill-php81 v1.29.0 php-composer
|
||||
symfony/polyfill-uuid v1.29.0 php-composer
|
||||
symfony/process v6.0.19 php-composer
|
||||
symfony/routing v6.0.19 php-composer
|
||||
symfony/service-contracts v3.0.2 php-composer
|
||||
symfony/string v6.0.19 php-composer
|
||||
symfony/translation v6.0.19 php-composer
|
||||
symfony/translation-contracts v3.0.2 php-composer
|
||||
symfony/uid v6.0.19 php-composer
|
||||
symfony/var-dumper v6.0.19 php-composer
|
||||
theseer/tokenizer 1.2.2 php-composer
|
||||
tijsverkoyen/css-to-inline-styles v2.2.7 php-composer
|
||||
tzdata 2024a-r0 apk
|
||||
utmps-libs 0.1.2.2-r0 apk
|
||||
vlucas/phpdotenv v5.6.0 php-composer
|
||||
voku/portable-ascii 2.0.1 php-composer
|
||||
webmozart/assert 1.11.0 php-composer
|
||||
xz-libs 5.4.5-r0 apk
|
||||
zlib 1.3.1-r0 apk
|
||||
zstd-libs 1.5.5-r8 apk
|
||||
|
||||
220
readme-vars.yml
220
readme-vars.yml
@ -3,173 +3,143 @@
|
||||
# project information
|
||||
project_name: bookstack
|
||||
project_url: "https://github.com/BookStackApp/BookStack"
|
||||
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/bookstack-logo.png"
|
||||
project_logo: "https://s3-us-west-2.amazonaws.com/linuxserver-docs/images/bookstack-logo500x500.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. 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_arm64 }}", tag: "arm64v8-latest"}
|
||||
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
|
||||
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
|
||||
|
||||
# container parameters
|
||||
param_container_name: "{{ project_name }}"
|
||||
param_usage_include_vols: true
|
||||
param_volumes:
|
||||
- {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files"}
|
||||
- { 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: "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: "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_HOST", env_value: "", desc: "The database instance hostname"}
|
||||
- {env_var: "DB_PORT", env_value: "3306", desc: "Database port"}
|
||||
- {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"}
|
||||
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
|
||||
- { env_var: "APP_URL", env_value: "yourbaseurl", 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: "DB_HOST", env_value: "yourdbhost", desc: "for specifying the database host" }
|
||||
- { env_var: "DB_PORT", env_value: "yourdbport", desc: "for specifying the database port if not default 3306" }
|
||||
- { env_var: "DB_USER", env_value: "yourdbuser", desc: "for specifying the database user" }
|
||||
- { env_var: "DB_PASS", env_value: "yourdbpass", desc: "for specifying the database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.)" }
|
||||
- { env_var: "DB_DATABASE", env_value: "bookstackapp", desc: "for specifying the database to be used" }
|
||||
|
||||
param_usage_include_ports: true
|
||||
param_ports:
|
||||
- {external_port: "6875", internal_port: "80", port_desc: "http/s web interface."}
|
||||
- { external_port: "6875", internal_port: "80", port_desc: "will map the container's port 80 to port 6875 on the host" }
|
||||
|
||||
opt_param_usage_include_env: true
|
||||
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)."}
|
||||
readonly_supported: true
|
||||
readonly_message: |
|
||||
* `/tmp` must be mounted to tmpfs
|
||||
- { 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: |
|
||||
---
|
||||
version: "2"
|
||||
services:
|
||||
bookstack:
|
||||
image: lscr.io/linuxserver/bookstack
|
||||
container_name: bookstack
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- APP_URL=https://bookstack.example.com
|
||||
- DB_HOST=bookstack_db
|
||||
- DB_PORT=3306
|
||||
- DB_USER=bookstack
|
||||
- DB_PASS=<yourdbpass>
|
||||
- DB_DATABASE=bookstackapp
|
||||
volumes:
|
||||
- ./bookstack_app_data:/config
|
||||
ports:
|
||||
- 6875:80
|
||||
restart: unless-stopped
|
||||
depends_on:
|
||||
- bookstack_db
|
||||
bookstack_db:
|
||||
image: lscr.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:
|
||||
- ./bookstack_db_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.
|
||||
|
||||
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.
|
||||
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 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/.
|
||||
|
||||
### 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/laravel.log` => `storage/logs/laravel.log`
|
||||
- `/config/www/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.
|
||||
|
||||
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: "28.12.25:", desc: "Rebase to Alpine 3.23."}
|
||||
- {date: "05.07.25:", desc: "Rebase to Alpine 3.22."}
|
||||
- {date: "04.01.25:", desc: "Add php-opcache."}
|
||||
- {date: "17.12.24:", desc: "Rebase to Alpine 3.21."}
|
||||
- {date: "11.10.24:", desc: "Default to environment config over .env file config."}
|
||||
- {date: "06.09.24:", desc: "Add php-exif for reading image EXIF data."}
|
||||
- {date: "27.05.24:", desc: "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings."}
|
||||
- {date: "25.01.24:", desc: "Existing users should update: site-confs/default.conf - Cleanup default site conf."}
|
||||
- {date: "23.12.23:", desc: "Rebase to Alpine 3.19 with php 8.3."}
|
||||
- {date: "31.10.23:", desc: "Further sanitize sed replace."}
|
||||
- {date: "07.06.23:", desc: "Add mariadb-client for bookstack-system-cli support."}
|
||||
- {date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf."}
|
||||
- {date: "13.04.23:", desc: "Move ssl.conf include to default.conf."}
|
||||
- {date: "01.03.23:", desc: "Add php iconv."}
|
||||
- {date: "19.01.23:", desc: "Rebase to alpine 3.17 with php8.1."}
|
||||
- {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."}
|
||||
- { date: "25.01.24:", desc: "Existing users should update: site-confs/default.conf - Cleanup default site conf." }
|
||||
- { date: "23.12.23:", desc: "Rebase to Alpine 3.19 with php 8.3."}
|
||||
- { date: "31.10.23:", desc: "Further sanitize sed replace." }
|
||||
- { date: "07.06.23:", desc: "Add mariadb-client for bookstack-system-cli support." }
|
||||
- { date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf." }
|
||||
- { date: "13.04.23:", desc: "Move ssl.conf include to default.conf." }
|
||||
- { date: "01.03.23:", desc: "Add php iconv." }
|
||||
- { date: "19.01.23:", desc: "Rebase to alpine 3.17 with php8.1." }
|
||||
- { 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." }
|
||||
|
||||
@ -1,9 +0,0 @@
|
||||
#!/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
|
||||
41
root/defaults/nginx/site-confs/default.conf.sample
Normal file
41
root/defaults/nginx/site-confs/default.conf.sample
Normal file
@ -0,0 +1,41 @@
|
||||
## Version 2023/12/25 - Changelog: https://github.com/linuxserver/docker-bookstack/commits/master/root/defaults/nginx/site-confs/default.conf.sample
|
||||
|
||||
server {
|
||||
listen 80 default_server;
|
||||
listen [::]:80 default_server;
|
||||
|
||||
listen 443 ssl http2 default_server;
|
||||
listen [::]:443 ssl http2 default_server;
|
||||
|
||||
server_name _;
|
||||
|
||||
include /config/nginx/ssl.conf;
|
||||
|
||||
root /app/www/public;
|
||||
index index.html index.htm index.php;
|
||||
|
||||
location / {
|
||||
# enable for basic auth
|
||||
#auth_basic "Restricted";
|
||||
#auth_basic_user_file /config/nginx/.htpasswd;
|
||||
|
||||
try_files $uri $uri/ /index.html /index.htm /index.php$is_args$args;
|
||||
}
|
||||
|
||||
location ~ ^(.+\.php)(.*)$ {
|
||||
# enable the next two lines for http auth
|
||||
#auth_basic "Restricted";
|
||||
#auth_basic_user_file /config/nginx/.htpasswd;
|
||||
|
||||
fastcgi_split_path_info ^(.+\.php)(.*)$;
|
||||
if (!-f $document_root$fastcgi_script_name) { return 404; }
|
||||
fastcgi_pass 127.0.0.1:9000;
|
||||
fastcgi_index index.php;
|
||||
include /etc/nginx/fastcgi_params;
|
||||
}
|
||||
|
||||
# deny access to .htaccess/.htpasswd files
|
||||
location ~ /\.ht {
|
||||
deny all;
|
||||
}
|
||||
}
|
||||
@ -4,27 +4,126 @@
|
||||
# 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."
|
||||
# create symlinks
|
||||
symlinks=(
|
||||
/app/www/themes
|
||||
/app/www/storage/uploads/files
|
||||
/app/www/storage/uploads/images
|
||||
/app/www/public/uploads
|
||||
/app/www/.env
|
||||
)
|
||||
|
||||
for i in "${symlinks[@]}"; do
|
||||
if [[ -e "${i}" && ! -L "${i}" ]]; then
|
||||
rm -rf "${i}"
|
||||
fi
|
||||
if [[ ! -L "${i}" ]]; then
|
||||
ln -s /config/www/"$(basename "${i}")" "${i}"
|
||||
fi
|
||||
done
|
||||
|
||||
if [[ -e "/app/www/storage/backups" && ! -L "/app/www/storage/backups" ]]; then
|
||||
rm -rf "/app/www/storage/backups"
|
||||
fi
|
||||
if [[ ! -L "/app/www/storage/backups" ]]; then
|
||||
ln -s "/config/backups" "/app/www/storage/backups"
|
||||
fi
|
||||
|
||||
if [[ -e "/app/www/storage/logs" && ! -L "/app/www/storage/logs" ]]; then
|
||||
rm -rf "/app/www/storage/logs"
|
||||
fi
|
||||
if [[ ! -L "/app/www/storage/logs" ]]; then
|
||||
ln -s "/config/log/bookstack" "/app/www/storage/logs"
|
||||
fi
|
||||
|
||||
# Echo init finish for test runs
|
||||
if [ -n "${TEST_RUN}" ]; then
|
||||
echo '[ls.io-init] 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 /app/www/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=${key}" /config/www/.env; then
|
||||
sed -i "s#^APP_KEY=.*#APP_KEY=${key}#" /config/www/.env
|
||||
fi
|
||||
|
||||
# if DB_HOST contains a port and DB_HOST is not a IPv6 without brackets [..]
|
||||
# support ipv4:port, [ipv6]:port, and domain:port
|
||||
if [[ ${DB_HOST} =~ :[0-9]+$ ]] && ! [[ ${DB_HOST} =~ ^(:{0,2}[a-fA-F0-9]{1,4})+$ ]]; then
|
||||
DB_HOST_PORT="${DB_HOST}"
|
||||
fi
|
||||
|
||||
# if DB_HOST_PORT is set
|
||||
if [[ -n "${DB_HOST_PORT}" ]]; then
|
||||
# if DB_PORT is set
|
||||
if [[ -n "${DB_PORT}" ]]; then
|
||||
echo "DB_PORT is not supported when using DB_HOST with port"
|
||||
sleep infinity
|
||||
fi
|
||||
DB_HOST="${DB_HOST_PORT%:*}"
|
||||
DB_PORT="${DB_HOST_PORT##*:}"
|
||||
fi
|
||||
|
||||
# if DB_PORT is not set
|
||||
if [[ -z "${DB_PORT}" ]]; then
|
||||
DB_PORT="3306"
|
||||
fi
|
||||
|
||||
# check to see if DB_HOST is set, if it is then run seds and if not then leave them
|
||||
if [[ -n "${DB_HOST}" ]]; then
|
||||
echo "Running config - DB_HOST set"
|
||||
|
||||
if ! grep -xqE "^[#]?DB_PORT=.*" /config/www/.env; then
|
||||
# add DB_PORT line to /config/www/.env because current /app/www/.env.example doesn't have it
|
||||
sed -i -E "/^[#]?DB_HOST=.*/a DB_PORT='${DB_PORT}'" /config/www/.env
|
||||
echo "**** Insert DB_PORT='${DB_PORT}' into /config/www/.env ****"
|
||||
fi
|
||||
|
||||
sed -i -E "s/^[#]?DB_HOST=.*/DB_HOST='${DB_HOST}'/g" /config/www/.env
|
||||
sed -i -E "s/^[#]?DB_PORT=.*/DB_PORT='${DB_PORT}'/g" /config/www/.env
|
||||
SED_DB_DATABASE=$(sed -e 's|[&\\/]|\\&|g; s|$|\\|; $s|\\$||' <<<"${DB_DATABASE}")
|
||||
sed -i -E "s/^[#]?DB_DATABASE=.*/DB_DATABASE='${SED_DB_DATABASE}'/g" /config/www/.env
|
||||
SED_DB_USER=$(sed -e 's|[&\\/]|\\&|g; s|$|\\|; $s|\\$||' <<<"${DB_USER}")
|
||||
sed -i -E "s/^[#]?DB_USERNAME=.*/DB_USERNAME='${SED_DB_USER}'/g" /config/www/.env
|
||||
SED_DB_PASS=$(sed -e 's|[&\\/]|\\&|g; s|$|\\|; $s|\\$||' <<<"${DB_PASS}")
|
||||
sed -i -E "s/^[#]?DB_PASSWORD=.*/DB_PASSWORD='${SED_DB_PASS}'/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 /app/www/artisan bookstack:update-url ${OLD_URL} ${APP_URL}"
|
||||
echo "************************************************************************"
|
||||
fi
|
||||
fi
|
||||
|
||||
## Bump php upload max filesize and post max size to 100MB by default
|
||||
@ -35,29 +134,33 @@ 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
|
||||
if [[ -n "${RUN}" ]]; then
|
||||
break
|
||||
fi
|
||||
RUN="RAN"
|
||||
# we sleep here again due to first run init on DB containers
|
||||
if [[ ! -f /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
|
||||
if [ -z "${CI_RUN+x}" ]; then
|
||||
php /app/www/artisan migrate --force
|
||||
fi
|
||||
|
||||
# permissions
|
||||
lsiown -R abc:abc \
|
||||
/app/www/storage \
|
||||
/config
|
||||
|
||||
# set lockfile to avoid DB waits for this specific container
|
||||
touch /dbwait.lock
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
# shellcheck shell=bash
|
||||
|
||||
if [[ -n "${QUEUE_CONNECTION}" ]]; then
|
||||
touch /etc/s6-overlay/s6-rc.d/user/contents.d/svc-queue-worker
|
||||
touch /etc/s6-overlay/s6-rc.d/user/contents.d/svc-queue-worker
|
||||
fi
|
||||
|
||||
exec \
|
||||
|
||||
0
root/migrations/02-default-location
Executable file → Normal file
0
root/migrations/02-default-location
Executable file → Normal file
Loading…
x
Reference in New Issue
Block a user