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 "v0.27-ls58" have entirely different histories.
master
...
v0.27-ls58
@ -1,20 +0,0 @@
|
|||||||
# This file is globally distributed to all container image projects from
|
|
||||||
# https://github.com/linuxserver/docker-jenkins-builder/blob/master/.editorconfig
|
|
||||||
|
|
||||||
# top-most EditorConfig file
|
|
||||||
root = true
|
|
||||||
|
|
||||||
# Unix-style newlines with a newline ending every file
|
|
||||||
[*]
|
|
||||||
end_of_line = lf
|
|
||||||
insert_final_newline = true
|
|
||||||
# trim_trailing_whitespace may cause unintended issues and should not be globally set true
|
|
||||||
trim_trailing_whitespace = false
|
|
||||||
|
|
||||||
[{Dockerfile*,**.yml}]
|
|
||||||
indent_style = space
|
|
||||||
indent_size = 2
|
|
||||||
|
|
||||||
[{**.sh,root/etc/s6-overlay/s6-rc.d/**,root/etc/cont-init.d/**,root/etc/services.d/**}]
|
|
||||||
indent_style = space
|
|
||||||
indent_size = 4
|
|
||||||
123
.github/CONTRIBUTING.md
vendored
123
.github/CONTRIBUTING.md
vendored
@ -1,123 +0,0 @@
|
|||||||
# Contributing to bookstack
|
|
||||||
|
|
||||||
## Gotchas
|
|
||||||
|
|
||||||
* While contributing make sure to make all your changes before creating a Pull Request, as our pipeline builds each commit after the PR is open.
|
|
||||||
* 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)
|
|
||||||
|
|
||||||
## Common files
|
|
||||||
|
|
||||||
| File | Use case |
|
|
||||||
| :----: | --- |
|
|
||||||
| `Dockerfile` | Dockerfile used to build amd64 images |
|
|
||||||
| `Dockerfile.aarch64` | Dockerfile used to build 64bit ARM architectures |
|
|
||||||
| `Dockerfile.armhf` | Dockerfile used to build 32bit ARM architectures |
|
|
||||||
| `Jenkinsfile` | This file is a product of our builder and should not be edited directly. This is used to build the image |
|
|
||||||
| `jenkins-vars.yml` | This file is used to generate the `Jenkinsfile` mentioned above, it only affects the build-process |
|
|
||||||
| `package_versions.txt` | This file is generated as a part of the build-process and should not be edited directly. It lists all the installed packages and their versions |
|
|
||||||
| `README.md` | This file is a product of our builder and should not be edited directly. This displays the readme for the repository and image registries |
|
|
||||||
| `readme-vars.yml` | This file is used to generate the `README.md` |
|
|
||||||
|
|
||||||
## Readme
|
|
||||||
|
|
||||||
If you would like to change our readme, please __**do not**__ directly edit the readme, as it is auto-generated on each commit.
|
|
||||||
Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-bookstack/edit/master/readme-vars.yml).
|
|
||||||
|
|
||||||
These variables are used in a template for our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) as part of an ansible play.
|
|
||||||
Most of these variables are also carried over to [docs.linuxserver.io](https://docs.linuxserver.io/images/docker-bookstack)
|
|
||||||
|
|
||||||
### Fixing typos or clarify the text in the readme
|
|
||||||
|
|
||||||
There are variables for multiple parts of the readme, the most common ones are:
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
| :----: | --- |
|
|
||||||
| `project_blurb` | This is the short excerpt shown above the project logo. |
|
|
||||||
| `app_setup_block` | This is the text that shows up under "Application Setup" if enabled |
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
|
|
||||||
The compose and run examples are also generated from these variables.
|
|
||||||
|
|
||||||
We have a [reference file](https://github.com/linuxserver/docker-jenkins-builder/blob/master/vars/_container-vars-blank) in our Jenkins Builder.
|
|
||||||
|
|
||||||
These are prefixed with `param_` for required parameters, or `opt_param` for optional parameters, except for `cap_add`.
|
|
||||||
Remember to enable param, if currently disabled. This differs between parameters, and can be seen in the reference file.
|
|
||||||
|
|
||||||
Devices, environment variables, ports and volumes expects its variables in a certain way.
|
|
||||||
|
|
||||||
### Devices
|
|
||||||
|
|
||||||
```yml
|
|
||||||
param_devices:
|
|
||||||
- { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" }
|
|
||||||
opt_param_devices:
|
|
||||||
- { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" }
|
|
||||||
```
|
|
||||||
|
|
||||||
### Environment variables
|
|
||||||
|
|
||||||
```yml
|
|
||||||
param_env_vars:
|
|
||||||
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
|
|
||||||
opt_param_env_vars:
|
|
||||||
- { env_var: "VERSION", env_value: "latest", desc: "Supported values are LATEST, PLEXPASS or a specific version number." }
|
|
||||||
```
|
|
||||||
|
|
||||||
### Ports
|
|
||||||
|
|
||||||
```yml
|
|
||||||
param_ports:
|
|
||||||
- { external_port: "80", internal_port: "80", port_desc: "Application WebUI" }
|
|
||||||
opt_param_ports:
|
|
||||||
- { external_port: "80", internal_port: "80", port_desc: "Application WebUI" }
|
|
||||||
```
|
|
||||||
|
|
||||||
### Volumes
|
|
||||||
|
|
||||||
```yml
|
|
||||||
param_volumes:
|
|
||||||
- { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "Configuration files." }
|
|
||||||
opt_param_volumes:
|
|
||||||
- { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "Configuration files." }
|
|
||||||
```
|
|
||||||
|
|
||||||
### Testing template changes
|
|
||||||
|
|
||||||
After you make any changes to the templates, you can use our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) to have the files updated from the modified templates. Please use the command found under `Running Locally` [on this page](https://github.com/linuxserver/docker-jenkins-builder/blob/master/README.md) to generate them prior to submitting a PR.
|
|
||||||
|
|
||||||
## Dockerfiles
|
|
||||||
|
|
||||||
We use multiple Dockerfiles in our repos, this is because sometimes some CPU architectures needs different packages to work.
|
|
||||||
If you are proposing additional packages to be added, ensure that you added the packages to all the Dockerfiles in alphabetical order.
|
|
||||||
|
|
||||||
### Testing your changes
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/linuxserver/docker-bookstack.git
|
|
||||||
cd docker-bookstack
|
|
||||||
docker build \
|
|
||||||
--no-cache \
|
|
||||||
--pull \
|
|
||||||
-t linuxserver/bookstack:latest .
|
|
||||||
```
|
|
||||||
|
|
||||||
The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
|
|
||||||
```
|
|
||||||
|
|
||||||
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
|
|
||||||
|
|
||||||
## Update the changelog
|
|
||||||
|
|
||||||
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-bookstack/tree/master/root), add an entry to the changelog
|
|
||||||
|
|
||||||
```yml
|
|
||||||
changelogs:
|
|
||||||
- { date: "DD.MM.YY:", desc: "Added some love to templates" }
|
|
||||||
```
|
|
||||||
2
.github/FUNDING.yml
vendored
2
.github/FUNDING.yml
vendored
@ -1,2 +0,0 @@
|
|||||||
github: linuxserver
|
|
||||||
open_collective: linuxserver
|
|
||||||
21
.github/ISSUE_TEMPLATE.md
vendored
Normal file
21
.github/ISSUE_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
<!--- Provide a general summary of the issue in the Title above -->
|
||||||
|
|
||||||
|
[linuxserverurl]: https://linuxserver.io
|
||||||
|
[][linuxserverurl]
|
||||||
|
|
||||||
|
|
||||||
|
<!--- If you have an issue with the project, please provide us with the following information -->
|
||||||
|
|
||||||
|
<!--- Host OS -->
|
||||||
|
<!--- Command line users, your run/create command, GUI/Unraid users, a screenshot of your template settings. -->
|
||||||
|
<!--- Docker log output, docker log <container-name> -->
|
||||||
|
<!--- Mention if you're using symlinks on any of the volume mounts. -->
|
||||||
|
|
||||||
|
|
||||||
|
<!--- If you have a suggestion or fix for the project, please provide us with the following information -->
|
||||||
|
|
||||||
|
<!--- What you think your suggestion brings to the project, or fixes with the project -->
|
||||||
|
<!--- If it's a fix, would it be better suited as a Pull request to the repo ? -->
|
||||||
|
|
||||||
|
## Thanks, team linuxserver.io
|
||||||
|
|
||||||
13
.github/ISSUE_TEMPLATE/config.yml
vendored
13
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1,13 +0,0 @@
|
|||||||
blank_issues_enabled: false
|
|
||||||
contact_links:
|
|
||||||
- name: Discord chat support
|
|
||||||
url: https://linuxserver.io/discord
|
|
||||||
about: Realtime support / chat with the community and the team.
|
|
||||||
|
|
||||||
- name: Discourse discussion forum
|
|
||||||
url: https://discourse.linuxserver.io
|
|
||||||
about: Post on our community forum.
|
|
||||||
|
|
||||||
- name: Documentation
|
|
||||||
url: https://docs.linuxserver.io/images/docker-bookstack
|
|
||||||
about: Documentation - information about all of our containers.
|
|
||||||
76
.github/ISSUE_TEMPLATE/issue.bug.yml
vendored
76
.github/ISSUE_TEMPLATE/issue.bug.yml
vendored
@ -1,76 +0,0 @@
|
|||||||
# Based on the issue template
|
|
||||||
name: Bug report
|
|
||||||
description: Create a report to help us improve
|
|
||||||
title: "[BUG] <title>"
|
|
||||||
labels: [Bug]
|
|
||||||
body:
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: Is there an existing issue for this?
|
|
||||||
description: Please search to see if an issue already exists for the bug you encountered.
|
|
||||||
options:
|
|
||||||
- label: I have searched the existing issues
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Current Behavior
|
|
||||||
description: Tell us what happens instead of the expected behavior.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Expected Behavior
|
|
||||||
description: Tell us what should happen.
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Steps To Reproduce
|
|
||||||
description: Steps to reproduce the behavior.
|
|
||||||
placeholder: |
|
|
||||||
1. In this environment...
|
|
||||||
2. With this config...
|
|
||||||
3. Run '...'
|
|
||||||
4. See error...
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Environment
|
|
||||||
description: |
|
|
||||||
examples:
|
|
||||||
- **OS**: Ubuntu 20.04
|
|
||||||
- **How docker service was installed**: distro's packagemanager
|
|
||||||
value: |
|
|
||||||
- OS:
|
|
||||||
- How docker service was installed:
|
|
||||||
render: markdown
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: dropdown
|
|
||||||
attributes:
|
|
||||||
label: CPU architecture
|
|
||||||
options:
|
|
||||||
- x86-64
|
|
||||||
- arm64
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Docker creation
|
|
||||||
description: |
|
|
||||||
Command used to create docker container
|
|
||||||
Provide your docker create/run command or compose yaml snippet, or a screenshot of settings if using a gui to create the container
|
|
||||||
render: bash
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
description: |
|
|
||||||
Provide a full docker log, output of "docker logs bookstack"
|
|
||||||
label: Container logs
|
|
||||||
placeholder: |
|
|
||||||
Output of `docker logs bookstack`
|
|
||||||
render: bash
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
31
.github/ISSUE_TEMPLATE/issue.feature.yml
vendored
31
.github/ISSUE_TEMPLATE/issue.feature.yml
vendored
@ -1,31 +0,0 @@
|
|||||||
# Based on the issue template
|
|
||||||
name: Feature request
|
|
||||||
description: Suggest an idea for this project
|
|
||||||
title: "[FEAT] <title>"
|
|
||||||
labels: [enhancement]
|
|
||||||
body:
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: Is this a new feature request?
|
|
||||||
description: Please search to see if a feature request already exists.
|
|
||||||
options:
|
|
||||||
- label: I have searched the existing issues
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Wanted change
|
|
||||||
description: Tell us what you want to happen.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Reason for change
|
|
||||||
description: Justify your request, why do you want it, what is the benefit.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Proposed code change
|
|
||||||
description: Do you have a potential code change in mind?
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
36
.github/PULL_REQUEST_TEMPLATE.md
vendored
36
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -2,42 +2,14 @@
|
|||||||
|
|
||||||
[linuxserverurl]: https://linuxserver.io
|
[linuxserverurl]: https://linuxserver.io
|
||||||
[][linuxserverurl]
|
[][linuxserverurl]
|
||||||
|
|
||||||
|
|
||||||
<!--- Before submitting a pull request please check the following -->
|
<!--- Before submitting a pull request please check the following -->
|
||||||
|
|
||||||
<!--- 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 -->
|
<!--- That you have made a branch in your fork, we'd rather not merge from your master -->
|
||||||
<!--- Ask yourself if this modification is something the whole userbase will benefit from, if this is a specific change for corner case functionality or plugins please look at making a Docker Mod or local script https://blog.linuxserver.io/2019/09/14/customizing-our-containers/ -->
|
|
||||||
<!--- That if the PR is addressing an existing issue include, closes #<issue number> , in the body of the PR commit message -->
|
<!--- That if the PR is addressing an existing issue include, closes #<issue number> , in the body of the PR commit message -->
|
||||||
<!--- You have included links to any files / patches etc your PR may be using in the body of the PR commit message -->
|
<!--- You have included links to any files / patches etc your PR may be using in the body of the PR commit message -->
|
||||||
<!--- We maintain a changelog of major revisions to the container at the end of readme-vars.yml in the root of this repository, please add your changes there if appropriate -->
|
<!--- -->
|
||||||
|
|
||||||
|
## Thanks, team linuxserver.io
|
||||||
|
|
||||||
<!--- Coding guidelines: -->
|
|
||||||
<!--- 1. Installed packages in the Dockerfiles should be in alphabetical order -->
|
|
||||||
<!--- 2. Changes to Dockerfile should be replicated in Dockerfile.armhf and Dockerfile.aarch64 if applicable -->
|
|
||||||
<!--- 3. Indentation style (tabs vs 4 spaces vs 1 space) should match the rest of the document -->
|
|
||||||
<!--- 4. Readme is auto generated from readme-vars.yml, make your changes there -->
|
|
||||||
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
- [ ] I have read the [contributing](https://github.com/linuxserver/docker-bookstack/blob/master/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
|
|
||||||
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
<!--- We welcome all PR’s though this doesn’t guarantee it will be accepted. -->
|
|
||||||
|
|
||||||
## Description:
|
|
||||||
<!--- Describe your changes in detail -->
|
|
||||||
|
|
||||||
## Benefits of this PR and context:
|
|
||||||
<!--- Please explain why we should accept this PR. If this fixes an outstanding bug, please reference the issue # -->
|
|
||||||
|
|
||||||
## How Has This Been Tested?
|
|
||||||
<!--- Please describe in detail how you tested your changes. -->
|
|
||||||
<!--- Include details of your testing environment, and the tests you ran to -->
|
|
||||||
<!--- see how your change affects other areas of the code, etc. -->
|
|
||||||
|
|
||||||
|
|
||||||
## Source / References:
|
|
||||||
<!--- Please include any forum posts/github links relevant to the PR -->
|
|
||||||
|
|||||||
19
.github/workflows/call_issue_pr_tracker.yml
vendored
19
.github/workflows/call_issue_pr_tracker.yml
vendored
@ -1,19 +0,0 @@
|
|||||||
name: Issue & PR Tracker
|
|
||||||
|
|
||||||
on:
|
|
||||||
issues:
|
|
||||||
types: [opened,reopened,labeled,unlabeled,closed]
|
|
||||||
pull_request_target:
|
|
||||||
types: [opened,reopened,review_requested,review_request_removed,labeled,unlabeled,closed]
|
|
||||||
pull_request_review:
|
|
||||||
types: [submitted,edited,dismissed]
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
manage-project:
|
|
||||||
permissions:
|
|
||||||
issues: write
|
|
||||||
uses: linuxserver/github-workflows/.github/workflows/issue-pr-tracker.yml@v1
|
|
||||||
secrets: inherit
|
|
||||||
16
.github/workflows/call_issues_cron.yml
vendored
16
.github/workflows/call_issues_cron.yml
vendored
@ -1,16 +0,0 @@
|
|||||||
name: Mark stale issues and pull requests
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
- cron: '3 9 * * *'
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
stale:
|
|
||||||
permissions:
|
|
||||||
issues: write
|
|
||||||
pull-requests: write
|
|
||||||
uses: linuxserver/github-workflows/.github/workflows/issues-cron.yml@v1
|
|
||||||
secrets: inherit
|
|
||||||
147
.github/workflows/external_trigger.yml
vendored
147
.github/workflows/external_trigger.yml
vendored
@ -1,147 +0,0 @@
|
|||||||
name: External Trigger Main
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
external-trigger-master:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4.1.1
|
|
||||||
|
|
||||||
- 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
|
|
||||||
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
|
|
||||||
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
|
|
||||||
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,
|
|
||||||
"description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n**Trigger URL:** '"${GHA_TRIGGER_URL}"' \n"}],
|
|
||||||
"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
|
|
||||||
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 \
|
|
||||||
--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
|
|
||||||
image_info=$(curl -sL \
|
|
||||||
--header "Authorization: Bearer ${token}" \
|
|
||||||
"https://ghcr.io/v2/${image}/blobs/${digest}")
|
|
||||||
if [[ $(echo $image_info | jq -r '.container_config') == "null" ]]; then
|
|
||||||
image_info=$(echo $image_info | jq -r '.config')
|
|
||||||
else
|
|
||||||
image_info=$(echo $image_info | jq -r '.container_config')
|
|
||||||
fi
|
|
||||||
IMAGE_RELEASE=$(echo ${image_info} | jq -r '.Labels.build_version' | awk '{print $3}')
|
|
||||||
IMAGE_VERSION=$(echo ${IMAGE_RELEASE} | awk -F'-ls' '{print $1}')
|
|
||||||
if [ -z "${IMAGE_VERSION}" ]; then
|
|
||||||
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "Can't retrieve last pushed version, exiting" >> $GITHUB_STEP_SUMMARY
|
|
||||||
FAILURE_REASON="Can't retrieve last pushed version for bookstack tag latest"
|
|
||||||
curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 16711680,
|
|
||||||
"description": "**Trigger Failed** \n**Reason:** '"${FAILURE_REASON}"' \n"}],
|
|
||||||
"username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
echo "Last pushed version: \`${IMAGE_VERSION}\`" >> $GITHUB_STEP_SUMMARY
|
|
||||||
if [ "${EXT_RELEASE_SANITIZED}" == "${IMAGE_VERSION}" ]; then
|
|
||||||
echo "Sanitized version \`${EXT_RELEASE_SANITIZED}\` already pushed, exiting" >> $GITHUB_STEP_SUMMARY
|
|
||||||
exit 0
|
|
||||||
elif [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/lastBuild/api/json | jq -r '.building') == "true" ]; then
|
|
||||||
echo "New version \`${EXT_RELEASE}\` found; but there already seems to be an active build on Jenkins; exiting" >> $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
|
|
||||||
fi
|
|
||||||
48
.github/workflows/external_trigger_scheduler.yml
vendored
48
.github/workflows/external_trigger_scheduler.yml
vendored
@ -1,48 +0,0 @@
|
|||||||
name: External Trigger Scheduler
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
- cron: '19 * * * *'
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
external-trigger-scheduler:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4.1.1
|
|
||||||
with:
|
|
||||||
fetch-depth: '0'
|
|
||||||
|
|
||||||
- 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)
|
|
||||||
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
|
|
||||||
ls_jenkins_vars=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/jenkins-vars.yml)
|
|
||||||
ls_branch=$(echo "${ls_jenkins_vars}" | yq -r '.ls_branch')
|
|
||||||
ls_trigger=$(echo "${ls_jenkins_vars}" | yq -r '.external_type')
|
|
||||||
if [[ "${br}" == "${ls_branch}" ]] && [[ "${ls_trigger}" != "os" ]]; then
|
|
||||||
echo "Branch appears to be live and trigger is not os; checking workflow." >> $GITHUB_STEP_SUMMARY
|
|
||||||
if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-bookstack/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then
|
|
||||||
echo "Triggering external trigger workflow for branch." >> $GITHUB_STEP_SUMMARY
|
|
||||||
curl -iX POST \
|
|
||||||
-H "Authorization: token ${{ secrets.CR_PAT }}" \
|
|
||||||
-H "Accept: application/vnd.github.v3+json" \
|
|
||||||
-d "{\"ref\":\"refs/heads/${br}\"}" \
|
|
||||||
https://api.github.com/repos/linuxserver/docker-bookstack/actions/workflows/external_trigger.yml/dispatches
|
|
||||||
else
|
|
||||||
echo "Skipping branch 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
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
19
.github/workflows/greetings.yml
vendored
19
.github/workflows/greetings.yml
vendored
@ -1,19 +0,0 @@
|
|||||||
name: Greetings
|
|
||||||
|
|
||||||
on: [pull_request_target, issues]
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
greeting:
|
|
||||||
permissions:
|
|
||||||
issues: write
|
|
||||||
pull-requests: write
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/first-interaction@v1
|
|
||||||
with:
|
|
||||||
issue-message: 'Thanks for opening your first issue here! Be sure to follow the relevant issue templates, or risk having this issue marked as invalid.'
|
|
||||||
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-bookstack/blob/master/.github/PULL_REQUEST_TEMPLATE.md)!'
|
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
103
.github/workflows/package_trigger_scheduler.yml
vendored
103
.github/workflows/package_trigger_scheduler.yml
vendored
@ -1,103 +0,0 @@
|
|||||||
name: Package Trigger Scheduler
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
- cron: '4 18 * * 1'
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
package-trigger-scheduler:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4.1.1
|
|
||||||
with:
|
|
||||||
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)
|
|
||||||
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
|
|
||||||
triggered_branches="${triggered_branches}${br} "
|
|
||||||
response=$(curl -iX POST \
|
|
||||||
https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/${br}/buildWithParameters?PACKAGE_CHECK=true \
|
|
||||||
--user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|")
|
|
||||||
if [[ -z "${response}" ]]; then
|
|
||||||
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "> Jenkins build could not be triggered. Skipping branch."
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
echo "Jenkins [job queue url](${response%$'\r'})" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "Sleeping 10 seconds until job starts" >> $GITHUB_STEP_SUMMARY
|
|
||||||
sleep 10
|
|
||||||
buildurl=$(curl -s "${response%$'\r'}api/json" | jq -r '.executable.url')
|
|
||||||
buildurl="${buildurl%$'\r'}"
|
|
||||||
echo "Jenkins job [build url](${buildurl})" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "Attempting to change the Jenkins job description" >> $GITHUB_STEP_SUMMARY
|
|
||||||
if ! curl -ifX POST \
|
|
||||||
"${buildurl}submitDescription" \
|
|
||||||
--user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} \
|
|
||||||
--data-urlencode "description=GHA package trigger https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
|
|
||||||
--data-urlencode "Submit=Submit"; then
|
|
||||||
echo "> [!WARNING]" >> $GITHUB_STEP_SUMMARY
|
|
||||||
echo "> Unable to change the Jenkins job description."
|
|
||||||
fi
|
|
||||||
sleep 20
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
echo "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
|
|
||||||
12
.github/workflows/permissions.yml
vendored
12
.github/workflows/permissions.yml
vendored
@ -1,12 +0,0 @@
|
|||||||
name: Permission check
|
|
||||||
on:
|
|
||||||
pull_request_target:
|
|
||||||
paths:
|
|
||||||
- '**/run'
|
|
||||||
- '**/finish'
|
|
||||||
- '**/check'
|
|
||||||
- 'root/migrations/*'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
permission_check:
|
|
||||||
uses: linuxserver/github-workflows/.github/workflows/init-svc-executable-permissions.yml@v1
|
|
||||||
1
.gitignore
vendored
1
.gitignore
vendored
@ -42,4 +42,3 @@ Network Trash Folder
|
|||||||
Temporary Items
|
Temporary Items
|
||||||
.apdisk
|
.apdisk
|
||||||
docker-compose.yml
|
docker-compose.yml
|
||||||
.jenkins-external
|
|
||||||
|
|||||||
110
Dockerfile
110
Dockerfile
@ -1,66 +1,74 @@
|
|||||||
# syntax=docker/dockerfile:1
|
FROM lsiobase/nginx:3.10
|
||||||
|
|
||||||
FROM ghcr.io/linuxserver/baseimage-alpine-nginx:3.23
|
|
||||||
|
|
||||||
# set version label
|
# set version label
|
||||||
ARG BUILD_DATE
|
ARG BUILD_DATE
|
||||||
ARG VERSION
|
ARG VERSION
|
||||||
ARG BOOKSTACK_RELEASE
|
ARG BOOKSTACK_RELEASE
|
||||||
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
|
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
|
||||||
LABEL maintainer="thespad"
|
LABEL maintainer="homerr"
|
||||||
|
|
||||||
ENV S6_STAGE2_HOOK="/init-hook"
|
# package versions
|
||||||
|
ARG BOOKSTACK_RELEASE
|
||||||
|
|
||||||
RUN \
|
RUN \
|
||||||
echo "**** install runtime packages ****" && \
|
echo "**** install packages ****" && \
|
||||||
apk add --no-cache \
|
apk add --no-cache \
|
||||||
fontconfig \
|
curl \
|
||||||
mariadb-client \
|
fontconfig \
|
||||||
memcached \
|
memcached \
|
||||||
php85-dom \
|
netcat-openbsd \
|
||||||
php85-exif \
|
php7-ctype \
|
||||||
php85-gd \
|
php7-curl \
|
||||||
php85-ldap \
|
php7-dom \
|
||||||
php85-mysqlnd \
|
php7-gd \
|
||||||
php85-pdo_mysql \
|
php7-ldap \
|
||||||
php85-pecl-memcached \
|
php7-mbstring \
|
||||||
php85-tokenizer \
|
php7-memcached \
|
||||||
qt5-qtbase \
|
php7-mysqlnd \
|
||||||
ttf-freefont && \
|
php7-openssl \
|
||||||
echo "**** configure php-fpm to pass env vars ****" && \
|
php7-pdo_mysql \
|
||||||
sed -E -i 's/^;?clear_env ?=.*$/clear_env = no/g' /etc/php85/php-fpm.d/www.conf && \
|
php7-phar \
|
||||||
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 && \
|
php7-simplexml \
|
||||||
echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php85/php-fpm.conf && \
|
php7-tidy \
|
||||||
echo "**** fetch bookstack ****" && \
|
php7-tokenizer \
|
||||||
mkdir -p\
|
qt5-qtbase \
|
||||||
/app/www && \
|
tar \
|
||||||
if [ -z ${BOOKSTACK_RELEASE+x} ]; then \
|
ttf-freefont \
|
||||||
BOOKSTACK_RELEASE=$(curl -sX GET "https://api.github.com/repos/bookstackapp/bookstack/releases/latest" \
|
wkhtmltopdf && \
|
||||||
| awk '/tag_name/{print $4;exit}' FS='[""]'); \
|
echo "**** tidy bug fix ****" && \
|
||||||
fi && \
|
curl -s \
|
||||||
curl -o \
|
http://dl-cdn.alpinelinux.org/alpine/v3.7/community/x86_64/tidyhtml-libs-5.4.0-r0.apk | \
|
||||||
/tmp/bookstack.tar.gz -L \
|
tar xfz - -C / && \
|
||||||
"https://github.com/BookStackApp/BookStack/archive/${BOOKSTACK_RELEASE}.tar.gz" && \
|
rm -f /usr/lib/libtidy.so.5.6.0 && \
|
||||||
tar xf \
|
echo "**** configure php-fpm ****" && \
|
||||||
/tmp/bookstack.tar.gz -C \
|
sed -i 's/;clear_env = no/clear_env = no/g' /etc/php7/php-fpm.d/www.conf && \
|
||||||
/app/www/ --strip-components=1 && \
|
echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php7/php-fpm.conf && \
|
||||||
echo "**** install composer dependencies ****" && \
|
echo "**** fetch bookstack ****" && \
|
||||||
composer install -d /app/www/ && \
|
mkdir -p\
|
||||||
printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \
|
/var/www/html && \
|
||||||
echo "**** create symlinks ****" && \
|
if [ -z ${BOOKSTACK_RELEASE+x} ]; then \
|
||||||
/bin/bash -c \
|
BOOKSTACK_RELEASE=$(curl -sX GET "https://api.github.com/repos/bookstackapp/bookstack/releases/latest" \
|
||||||
'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); \
|
| awk '/tag_name/{print $4;exit}' FS='[""]'); \
|
||||||
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); \
|
fi && \
|
||||||
for i in "${!src[@]}"; do rm -rf /app/www/"${src[i]}" && ln -s /config/"${dst[i]}" /app/www/"${src[i]}"; done' && \
|
curl -o \
|
||||||
echo "**** cleanup ****" && \
|
/tmp/bookstack.tar.gz -L \
|
||||||
rm -rf \
|
"https://github.com/BookStackApp/BookStack/archive/${BOOKSTACK_RELEASE}.tar.gz" && \
|
||||||
/tmp/* \
|
tar xf \
|
||||||
$HOME/.cache \
|
/tmp/bookstack.tar.gz -C \
|
||||||
$HOME/.composer
|
/var/www/html/ --strip-components=1 && \
|
||||||
|
echo "**** install composer ****" && \
|
||||||
|
cd /tmp && \
|
||||||
|
curl -sS https://getcomposer.org/installer | php && \
|
||||||
|
mv /tmp/composer.phar /usr/local/bin/composer && \
|
||||||
|
echo "**** install composer dependencies ****" && \
|
||||||
|
composer install -d /var/www/html/ && \
|
||||||
|
echo "**** cleanup ****" && \
|
||||||
|
rm -rf \
|
||||||
|
/root/.composer \
|
||||||
|
/tmp/*
|
||||||
|
|
||||||
# copy local files
|
# copy local files
|
||||||
COPY root/ /
|
COPY root/ /
|
||||||
|
|
||||||
# ports and volumes
|
# ports and volumes
|
||||||
EXPOSE 80 443
|
|
||||||
VOLUME /config
|
VOLUME /config
|
||||||
|
|||||||
@ -1,66 +1,74 @@
|
|||||||
# syntax=docker/dockerfile:1
|
FROM lsiobase/nginx:arm64v8-3.10
|
||||||
|
|
||||||
FROM ghcr.io/linuxserver/baseimage-alpine-nginx:arm64v8-3.23
|
|
||||||
|
|
||||||
# set version label
|
# set version label
|
||||||
ARG BUILD_DATE
|
ARG BUILD_DATE
|
||||||
ARG VERSION
|
ARG VERSION
|
||||||
ARG BOOKSTACK_RELEASE
|
ARG BOOKSTACK_RELEASE
|
||||||
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
|
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
|
||||||
LABEL maintainer="thespad"
|
LABEL maintainer="homerr"
|
||||||
|
|
||||||
ENV S6_STAGE2_HOOK="/init-hook"
|
# package versions
|
||||||
|
ARG BOOKSTACK_RELEASE
|
||||||
|
|
||||||
RUN \
|
RUN \
|
||||||
echo "**** install runtime packages ****" && \
|
echo "**** install packages ****" && \
|
||||||
apk add --no-cache \
|
apk add --no-cache \
|
||||||
fontconfig \
|
curl \
|
||||||
mariadb-client \
|
fontconfig \
|
||||||
memcached \
|
memcached \
|
||||||
php85-dom \
|
netcat-openbsd \
|
||||||
php85-exif \
|
php7-ctype \
|
||||||
php85-gd \
|
php7-curl \
|
||||||
php85-ldap \
|
php7-dom \
|
||||||
php85-mysqlnd \
|
php7-gd \
|
||||||
php85-pdo_mysql \
|
php7-ldap \
|
||||||
php85-pecl-memcached \
|
php7-mbstring \
|
||||||
php85-tokenizer \
|
php7-memcached \
|
||||||
qt5-qtbase \
|
php7-mysqlnd \
|
||||||
ttf-freefont && \
|
php7-openssl \
|
||||||
echo "**** configure php-fpm to pass env vars ****" && \
|
php7-pdo_mysql \
|
||||||
sed -E -i 's/^;?clear_env ?=.*$/clear_env = no/g' /etc/php85/php-fpm.d/www.conf && \
|
php7-phar \
|
||||||
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 && \
|
php7-simplexml \
|
||||||
echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php85/php-fpm.conf && \
|
php7-tidy \
|
||||||
echo "**** fetch bookstack ****" && \
|
php7-tokenizer \
|
||||||
mkdir -p\
|
qt5-qtbase \
|
||||||
/app/www && \
|
tar \
|
||||||
if [ -z ${BOOKSTACK_RELEASE+x} ]; then \
|
ttf-freefont \
|
||||||
BOOKSTACK_RELEASE=$(curl -sX GET "https://api.github.com/repos/bookstackapp/bookstack/releases/latest" \
|
wkhtmltopdf && \
|
||||||
| awk '/tag_name/{print $4;exit}' FS='[""]'); \
|
echo "**** tidy bug fix ****" && \
|
||||||
fi && \
|
curl -s \
|
||||||
curl -o \
|
http://dl-cdn.alpinelinux.org/alpine/v3.7/community/aarch64/tidyhtml-libs-5.4.0-r0.apk | \
|
||||||
/tmp/bookstack.tar.gz -L \
|
tar xfz - -C / && \
|
||||||
"https://github.com/BookStackApp/BookStack/archive/${BOOKSTACK_RELEASE}.tar.gz" && \
|
rm -f /usr/lib/libtidy.so.5.6.0 && \
|
||||||
tar xf \
|
echo "**** configure php-fpm ****" && \
|
||||||
/tmp/bookstack.tar.gz -C \
|
sed -i 's/;clear_env = no/clear_env = no/g' /etc/php7/php-fpm.d/www.conf && \
|
||||||
/app/www/ --strip-components=1 && \
|
echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php7/php-fpm.conf && \
|
||||||
echo "**** install composer dependencies ****" && \
|
echo "**** fetch bookstack ****" && \
|
||||||
composer install -d /app/www/ && \
|
mkdir -p\
|
||||||
printf "Linuxserver.io version: ${VERSION}\nBuild-date: ${BUILD_DATE}" > /build_version && \
|
/var/www/html && \
|
||||||
echo "**** create symlinks ****" && \
|
if [ -z ${BOOKSTACK_RELEASE+x} ]; then \
|
||||||
/bin/bash -c \
|
BOOKSTACK_RELEASE=$(curl -sX GET "https://api.github.com/repos/bookstackapp/bookstack/releases/latest" \
|
||||||
'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); \
|
| awk '/tag_name/{print $4;exit}' FS='[""]'); \
|
||||||
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); \
|
fi && \
|
||||||
for i in "${!src[@]}"; do rm -rf /app/www/"${src[i]}" && ln -s /config/"${dst[i]}" /app/www/"${src[i]}"; done' && \
|
curl -o \
|
||||||
echo "**** cleanup ****" && \
|
/tmp/bookstack.tar.gz -L \
|
||||||
rm -rf \
|
"https://github.com/BookStackApp/BookStack/archive/${BOOKSTACK_RELEASE}.tar.gz" && \
|
||||||
/tmp/* \
|
tar xf \
|
||||||
$HOME/.cache \
|
/tmp/bookstack.tar.gz -C \
|
||||||
$HOME/.composer
|
/var/www/html/ --strip-components=1 && \
|
||||||
|
echo "**** install composer ****" && \
|
||||||
|
cd /tmp && \
|
||||||
|
curl -sS https://getcomposer.org/installer | php && \
|
||||||
|
mv /tmp/composer.phar /usr/local/bin/composer && \
|
||||||
|
echo "**** install composer dependencies ****" && \
|
||||||
|
composer install -d /var/www/html/ && \
|
||||||
|
echo "**** cleanup ****" && \
|
||||||
|
rm -rf \
|
||||||
|
/root/.composer \
|
||||||
|
/tmp/*
|
||||||
|
|
||||||
# copy local files
|
# copy local files
|
||||||
COPY root/ /
|
COPY root/ /
|
||||||
|
|
||||||
# ports and volumes
|
# ports and volumes
|
||||||
EXPOSE 80 443
|
|
||||||
VOLUME /config
|
VOLUME /config
|
||||||
|
|||||||
69
Dockerfile.armhf
Normal file
69
Dockerfile.armhf
Normal file
@ -0,0 +1,69 @@
|
|||||||
|
FROM lsiobase/nginx:arm32v7-3.10
|
||||||
|
|
||||||
|
# set version label
|
||||||
|
ARG BUILD_DATE
|
||||||
|
ARG VERSION
|
||||||
|
ARG BOOKSTACK_RELEASE
|
||||||
|
LABEL build_version="Linuxserver.io version:- ${VERSION} Build-date:- ${BUILD_DATE}"
|
||||||
|
LABEL maintainer="homerr"
|
||||||
|
|
||||||
|
# package versions
|
||||||
|
ARG BOOKSTACK_RELEASE
|
||||||
|
|
||||||
|
RUN \
|
||||||
|
echo "**** install packages ****" && \
|
||||||
|
apk add --no-cache \
|
||||||
|
curl \
|
||||||
|
fontconfig \
|
||||||
|
memcached \
|
||||||
|
netcat-openbsd \
|
||||||
|
php7-ctype \
|
||||||
|
php7-curl \
|
||||||
|
php7-dom \
|
||||||
|
php7-gd \
|
||||||
|
php7-ldap \
|
||||||
|
php7-mbstring \
|
||||||
|
php7-memcached \
|
||||||
|
php7-mysqlnd \
|
||||||
|
php7-openssl \
|
||||||
|
php7-pdo_mysql \
|
||||||
|
php7-phar \
|
||||||
|
php7-simplexml \
|
||||||
|
php7-tidy \
|
||||||
|
php7-tokenizer \
|
||||||
|
qt5-qtbase \
|
||||||
|
tar \
|
||||||
|
ttf-freefont \
|
||||||
|
wkhtmltopdf && \
|
||||||
|
echo "**** configure php-fpm ****" && \
|
||||||
|
sed -i 's/;clear_env = no/clear_env = no/g' /etc/php7/php-fpm.d/www.conf && \
|
||||||
|
echo "env[PATH] = /usr/local/bin:/usr/bin:/bin" >> /etc/php7/php-fpm.conf && \
|
||||||
|
echo "**** fetch bookstack ****" && \
|
||||||
|
mkdir -p\
|
||||||
|
/var/www/html && \
|
||||||
|
if [ -z ${BOOKSTACK_RELEASE+x} ]; then \
|
||||||
|
BOOKSTACK_RELEASE=$(curl -sX GET "https://api.github.com/repos/bookstackapp/bookstack/releases/latest" \
|
||||||
|
| awk '/tag_name/{print $4;exit}' FS='[""]'); \
|
||||||
|
fi && \
|
||||||
|
curl -o \
|
||||||
|
/tmp/bookstack.tar.gz -L \
|
||||||
|
"https://github.com/BookStackApp/BookStack/archive/${BOOKSTACK_RELEASE}.tar.gz" && \
|
||||||
|
tar xf \
|
||||||
|
/tmp/bookstack.tar.gz -C \
|
||||||
|
/var/www/html/ --strip-components=1 && \
|
||||||
|
echo "**** install composer ****" && \
|
||||||
|
cd /tmp && \
|
||||||
|
curl -sS https://getcomposer.org/installer | php && \
|
||||||
|
mv /tmp/composer.phar /usr/local/bin/composer && \
|
||||||
|
echo "**** install composer dependencies ****" && \
|
||||||
|
composer install -d /var/www/html/ && \
|
||||||
|
echo "**** cleanup ****" && \
|
||||||
|
rm -rf \
|
||||||
|
/root/.composer \
|
||||||
|
/tmp/*
|
||||||
|
|
||||||
|
# copy local files
|
||||||
|
COPY root/ /
|
||||||
|
|
||||||
|
# ports and volumes
|
||||||
|
VOLUME /config
|
||||||
1056
Jenkinsfile
vendored
1056
Jenkinsfile
vendored
File diff suppressed because it is too large
Load Diff
425
README.md
425
README.md
@ -1,374 +1,235 @@
|
|||||||
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
|
||||||
<!-- Please read https://github.com/linuxserver/docker-bookstack/blob/master/.github/CONTRIBUTING.md -->
|
|
||||||
[](https://linuxserver.io)
|
[](https://linuxserver.io)
|
||||||
|
|
||||||
[](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
|
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
|
||||||
[](https://linuxserver.io/discord "realtime support / chat with the community and the team.")
|
|
||||||
[](https://discourse.linuxserver.io "post on our community forum.")
|
|
||||||
[](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")
|
|
||||||
|
|
||||||
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
|
* regular and timely application updates
|
||||||
|
* easy user mappings (PGID, PUID)
|
||||||
* regular and timely application updates
|
* custom base image with s6 overlay
|
||||||
* easy user mappings (PGID, PUID)
|
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
|
||||||
* custom base image with s6 overlay
|
* regular security updates
|
||||||
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
|
|
||||||
* regular security updates
|
|
||||||
|
|
||||||
Find us at:
|
Find us at:
|
||||||
|
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
|
||||||
|
* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
|
||||||
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
|
* [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.
|
|
||||||
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
|
|
||||||
* [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)
|
# [linuxserver/bookstack](https://github.com/linuxserver/docker-bookstack)
|
||||||
|
[](https://discord.gg/YWrKVTn)
|
||||||
|
[](https://microbadger.com/images/linuxserver/bookstack "Get your own version badge on microbadger.com")
|
||||||
|
[](https://microbadger.com/images/linuxserver/bookstack "Get your own version badge on microbadger.com")
|
||||||
|

|
||||||
|

|
||||||
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-bookstack/job/master/)
|
||||||
|
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/bookstack/latest/index.html)
|
||||||
|
|
||||||
[](https://scarf.sh)
|
[Bookstack](https://github.com/BookStackApp/BookStack) is a free and open source Wiki designed for creating beautiful documentation. Feautring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
|
||||||
[](https://github.com/linuxserver/docker-bookstack)
|
|
||||||
[](https://github.com/linuxserver/docker-bookstack/releases)
|
|
||||||
[](https://github.com/linuxserver/docker-bookstack/packages)
|
|
||||||
[](https://gitlab.com/linuxserver.io/docker-bookstack/container_registry)
|
|
||||||
[](https://quay.io/repository/linuxserver.io/bookstack)
|
|
||||||
[](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/)
|
|
||||||
|
|
||||||
[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.
|
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
|
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
|
## Supported Architectures
|
||||||
|
|
||||||
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||||||
|
|
||||||
Simply pulling `lscr.io/linuxserver/bookstack:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
Simply pulling `linuxserver/bookstack` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
||||||
|
|
||||||
The architectures supported by this image are:
|
The architectures supported by this image are:
|
||||||
|
|
||||||
| Architecture | Available | Tag |
|
| Architecture | Tag |
|
||||||
| :----: | :----: | ---- |
|
| :----: | --- |
|
||||||
| x86-64 | ✅ | amd64-\<version tag\> |
|
| x86-64 | amd64-latest |
|
||||||
| arm64 | ✅ | arm64v8-\<version tag\> |
|
| arm64 | arm64v8-latest |
|
||||||
|
| armhf | arm32v7-latest |
|
||||||
|
|
||||||
## Application Setup
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the `APP_URL` environment variable is set to your external domain, or it will not work.
|
|
||||||
|
|
||||||
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/.
|
|
||||||
|
|
||||||
### BookStack File & Directory Paths
|
|
||||||
|
|
||||||
This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the `/config` folder so that they are persistent & accessible when the `/config` container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation.
|
|
||||||
|
|
||||||
Below is a mapping of container `/config` paths to those relative within a BookStack install directory:
|
|
||||||
|
|
||||||
- **/config container path** => **BookStack relative path**
|
|
||||||
- `/config/www/.env` => `.env`
|
|
||||||
- `/config/log/bookstack/laravel.log` => `storage/logs/laravel.log`
|
|
||||||
- `/config/backups/` => `storage/backups/`
|
|
||||||
- `/config/www/files/` => `storage/uploads/files/`
|
|
||||||
- `/config/www/images/` => `storage/uploads/images/`
|
|
||||||
- `/config/www/themes/` => `themes/`
|
|
||||||
- `/config/www/uploads/` => `public/uploads/`
|
|
||||||
|
|
||||||
### Changing APP_URL
|
|
||||||
|
|
||||||
If you change the APP_URL after initial install, you should run the following line from your host terminal to update the database URL entries:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
docker exec -it bookstack php /app/www/artisan bookstack:update-url ${OLD_URL} ${NEW_URL}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Advanced Users (full control over the .env file)
|
|
||||||
|
|
||||||
If you wish to use the extra functionality of BookStack such as email, 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
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
|
Here are some example snippets to help you get started creating a container.
|
||||||
|
|
||||||
>[!NOTE]
|
### docker
|
||||||
>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))
|
```
|
||||||
|
docker create \
|
||||||
|
--name=bookstack \
|
||||||
|
-e PUID=1000 \
|
||||||
|
-e PGID=1000 \
|
||||||
|
-e DB_HOST=<yourdbhost> \
|
||||||
|
-e DB_USER=<yourdbuser> \
|
||||||
|
-e DB_PASS=<yourdbpass> \
|
||||||
|
-e DB_DATABASE=bookstackapp \
|
||||||
|
-e APP_URL=http://your.site.here.xyz `#optional` \
|
||||||
|
-p 6875:80 \
|
||||||
|
-v <path to data>:/config \
|
||||||
|
--restart unless-stopped \
|
||||||
|
linuxserver/bookstack
|
||||||
|
```
|
||||||
|
|
||||||
```yaml
|
|
||||||
|
### docker-compose
|
||||||
|
|
||||||
|
Compatible with docker-compose v2 schemas.
|
||||||
|
|
||||||
|
```
|
||||||
---
|
---
|
||||||
|
version: "2"
|
||||||
services:
|
services:
|
||||||
bookstack:
|
bookstack:
|
||||||
image: lscr.io/linuxserver/bookstack:latest
|
image: linuxserver/bookstack
|
||||||
container_name: bookstack
|
container_name: bookstack
|
||||||
environment:
|
environment:
|
||||||
- PUID=1000
|
- PUID=1000
|
||||||
- PGID=1000
|
- PGID=1000
|
||||||
- TZ=Etc/UTC
|
- DB_HOST=bookstack_db
|
||||||
- APP_URL=
|
- DB_USER=bookstack
|
||||||
- APP_KEY=
|
- DB_PASS=<yourdbpass>
|
||||||
- DB_HOST=
|
- DB_DATABASE=bookstackapp
|
||||||
- DB_PORT=3306
|
|
||||||
- DB_USERNAME=
|
|
||||||
- DB_PASSWORD=
|
|
||||||
- DB_DATABASE=
|
|
||||||
- QUEUE_CONNECTION= #optional
|
|
||||||
volumes:
|
volumes:
|
||||||
- /path/to/bookstack/config:/config
|
- <path to data>:/config
|
||||||
ports:
|
ports:
|
||||||
- 6875:80
|
- 6875:80
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
```
|
depends_on:
|
||||||
|
- bookstack_db
|
||||||
|
bookstack_db:
|
||||||
|
image: linuxserver/mariadb
|
||||||
|
container_name: bookstack_db
|
||||||
|
environment:
|
||||||
|
- PUID=1000
|
||||||
|
- PGID=1000
|
||||||
|
- MYSQL_ROOT_PASSWORD=<yourdbpass>
|
||||||
|
- TZ=Europe/London
|
||||||
|
- MYSQL_DATABASE=bookstackapp
|
||||||
|
- MYSQL_USER=bookstack
|
||||||
|
- MYSQL_PASSWORD=<yourdbpass>
|
||||||
|
volumes:
|
||||||
|
- <path to data>:/config
|
||||||
|
restart: unless-stopped
|
||||||
|
|
||||||
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker run -d \
|
|
||||||
--name=bookstack \
|
|
||||||
-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 QUEUE_CONNECTION= `#optional` \
|
|
||||||
-p 6875:80 \
|
|
||||||
-v /path/to/bookstack/config:/config \
|
|
||||||
--restart unless-stopped \
|
|
||||||
lscr.io/linuxserver/bookstack:latest
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
|
|
||||||
Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||||
|
|
||||||
| Parameter | Function |
|
| 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 PUID=1000` | for UserID - see below for explanation |
|
||||||
| `-e PGID=1000` | for GroupID - 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 DB_HOST=<yourdbhost>` | for specifying the database host |
|
||||||
| `-e APP_URL=` | The protocol, IP/URL, and port that your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com` |
|
| `-e DB_USER=<yourdbuser>` | for specifying the database user |
|
||||||
| `-e APP_KEY=` | Session encryption key. You will need to generate this with `docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey` |
|
| `-e DB_PASS=<yourdbpass>` | for specifying the database password |
|
||||||
| `-e DB_HOST=` | The database instance hostname |
|
| `-e DB_DATABASE=bookstackapp` | for specifying the database to be used |
|
||||||
| `-e DB_PORT=3306` | Database port |
|
| `-e APP_URL=http://your.site.here.xyz` | for specifying the url your application will be accessed on (required for correct operation of reverse proxy) |
|
||||||
| `-e DB_USERNAME=` | Database user |
|
| `-v /config` | this will store any uploaded data on the docker host |
|
||||||
| `-e DB_PASSWORD=` | Database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.) |
|
|
||||||
| `-e DB_DATABASE=` | Database name |
|
|
||||||
| `-e QUEUE_CONNECTION=` | Set to `database` to enable async actions like sending email or triggering webhooks. See [documentation](https://www.bookstackapp.com/docs/admin/email-webhooks/#async-action-handling). |
|
|
||||||
| `-v /config` | Persistent config files |
|
|
||||||
| `--read-only=true` | Run container with a read-only filesystem. Please [read the docs](https://docs.linuxserver.io/misc/read-only/). |
|
|
||||||
|
|
||||||
## Environment variables from files (Docker secrets)
|
|
||||||
|
|
||||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
|
||||||
|
|
||||||
As an example:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
-e FILE__MYVAR=/run/secrets/mysecretvariable
|
|
||||||
```
|
|
||||||
|
|
||||||
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
|
|
||||||
|
|
||||||
## Umask for running applications
|
|
||||||
|
|
||||||
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
|
|
||||||
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
|
||||||
|
|
||||||
## User / Group Identifiers
|
## User / Group Identifiers
|
||||||
|
|
||||||
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
||||||
|
|
||||||
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
||||||
|
|
||||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
|
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||||
|
|
||||||
```bash
|
```
|
||||||
id your_user
|
$ id username
|
||||||
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||||
```
|
```
|
||||||
|
|
||||||
Example output:
|
|
||||||
|
|
||||||
```text
|
|
||||||
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
|
## Application Setup
|
||||||
```
|
|
||||||
|
|
||||||
## Docker Mods
|
|
||||||
|
|
||||||
[](https://mods.linuxserver.io/?mod=bookstack "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
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 LetsEncrypt container or Traefik you will need to make sure that the `APP_URL` environment variable is set, or it will not work
|
||||||
|
|
||||||
|
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
|
||||||
|
|
||||||
|
### 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, or APP_URL. The container will copy an .env file to /config/www/.env on your host system for you to edit. When you create the container, do not set any arguments for any SQL settings, or APP_URL. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
|
||||||
|
|
||||||
|
#### PDF Rendering
|
||||||
|
[wkhtmltopdf](https://wkhtmltopdf.org/) is available to use as an alternative PDF rendering generator as described at https://www.bookstackapp.com/docs/admin/pdf-rendering/.
|
||||||
|
|
||||||
|
The path to wkhtmltopdf in this image to include in your .env file is `/usr/bin/wkhtmltopdf`.
|
||||||
|
|
||||||
|
|
||||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
|
|
||||||
|
|
||||||
## Support Info
|
## Support Info
|
||||||
|
|
||||||
* Shell access whilst the container is running:
|
* Shell access whilst the container is running: `docker exec -it bookstack /bin/bash`
|
||||||
|
* To monitor the logs of the container in realtime: `docker logs -f bookstack`
|
||||||
```bash
|
* container version number
|
||||||
docker exec -it bookstack /bin/bash
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack`
|
||||||
```
|
* image version number
|
||||||
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/bookstack`
|
||||||
* To monitor the logs of the container in realtime:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker logs -f bookstack
|
|
||||||
```
|
|
||||||
|
|
||||||
* Container version number:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack
|
|
||||||
```
|
|
||||||
|
|
||||||
* Image version number:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/bookstack:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
## Updating Info
|
## Updating Info
|
||||||
|
|
||||||
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
|
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
|
||||||
|
|
||||||
Below are the instructions for updating containers:
|
Below are the instructions for updating containers:
|
||||||
|
|
||||||
|
### Via Docker Run/Create
|
||||||
|
* Update the image: `docker pull linuxserver/bookstack`
|
||||||
|
* Stop the running container: `docker stop bookstack`
|
||||||
|
* Delete the container: `docker rm bookstack`
|
||||||
|
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
|
||||||
|
* Start the new container: `docker start bookstack`
|
||||||
|
* You can also remove the old dangling images: `docker image prune`
|
||||||
|
|
||||||
### Via Docker Compose
|
### Via Docker Compose
|
||||||
|
* Update all images: `docker-compose pull`
|
||||||
|
* or update a single image: `docker-compose pull bookstack`
|
||||||
|
* Let compose update all containers as necessary: `docker-compose up -d`
|
||||||
|
* or update a single container: `docker-compose up -d bookstack`
|
||||||
|
* You can also remove the old dangling images: `docker image prune`
|
||||||
|
|
||||||
* Update images:
|
### Via Watchtower auto-updater (especially useful if you don't remember the original parameters)
|
||||||
* All images:
|
* Pull the latest image at its tag and replace it with the same env variables in one run:
|
||||||
|
```
|
||||||
|
docker run --rm \
|
||||||
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||||
|
containrrr/watchtower \
|
||||||
|
--run-once bookstack
|
||||||
|
```
|
||||||
|
|
||||||
```bash
|
**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.
|
||||||
docker-compose pull
|
|
||||||
```
|
|
||||||
|
|
||||||
* Single image:
|
* You can also remove the old dangling images: `docker image prune`
|
||||||
|
|
||||||
```bash
|
|
||||||
docker-compose pull bookstack
|
|
||||||
```
|
|
||||||
|
|
||||||
* Update containers:
|
|
||||||
* All containers:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker-compose up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
* Single container:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker-compose up -d bookstack
|
|
||||||
```
|
|
||||||
|
|
||||||
* You can also remove the old dangling images:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker image prune
|
|
||||||
```
|
|
||||||
|
|
||||||
### Via Docker Run
|
|
||||||
|
|
||||||
* Update the image:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker pull lscr.io/linuxserver/bookstack:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
* Stop the running container:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker stop bookstack
|
|
||||||
```
|
|
||||||
|
|
||||||
* Delete the container:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker rm bookstack
|
|
||||||
```
|
|
||||||
|
|
||||||
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
|
|
||||||
* You can also remove the old dangling images:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker image prune
|
|
||||||
```
|
|
||||||
|
|
||||||
### 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.
|
|
||||||
|
|
||||||
## Building locally
|
## Building locally
|
||||||
|
|
||||||
If you want to make local modifications to these images for development purposes or just to customize the logic:
|
If you want to make local modifications to these images for development purposes or just to customize the logic:
|
||||||
|
```
|
||||||
```bash
|
|
||||||
git clone https://github.com/linuxserver/docker-bookstack.git
|
git clone https://github.com/linuxserver/docker-bookstack.git
|
||||||
cd docker-bookstack
|
cd docker-bookstack
|
||||||
docker build \
|
docker build \
|
||||||
--no-cache \
|
--no-cache \
|
||||||
--pull \
|
--pull \
|
||||||
-t lscr.io/linuxserver/bookstack:latest .
|
-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 multiarch/qemu-user-static:register --reset
|
||||||
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
|
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
|
||||||
|
|
||||||
## Versions
|
## Versions
|
||||||
|
|
||||||
* **28.12.25:** - Rebase to Alpine 3.23.
|
|
||||||
* **05.07.25:** - Rebase to Alpine 3.22.
|
|
||||||
* **04.01.25:** - Add php-opcache.
|
|
||||||
* **17.12.24:** - Rebase to Alpine 3.21.
|
|
||||||
* **11.10.24:** - Default to environment config over .env file config.
|
|
||||||
* **06.09.24:** - Add php-exif for reading image EXIF data.
|
|
||||||
* **27.05.24:** - Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings.
|
|
||||||
* **25.01.24:** - Existing users should update: site-confs/default.conf - Cleanup default site conf.
|
|
||||||
* **23.12.23:** - Rebase to Alpine 3.19 with php 8.3.
|
|
||||||
* **31.10.23:** - Further sanitize sed replace.
|
|
||||||
* **07.06.23:** - Add mariadb-client for bookstack-system-cli support.
|
|
||||||
* **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf.
|
|
||||||
* **13.04.23:** - Move ssl.conf include to default.conf.
|
|
||||||
* **01.03.23:** - Add php iconv.
|
|
||||||
* **19.01.23:** - Rebase to alpine 3.17 with php8.1.
|
|
||||||
* **16.01.23:** - Wrap `.env` values in quotes.
|
|
||||||
* **05.01.23:** - Fix db password setting (sed escape `&`).
|
|
||||||
* **21.12.22:** - Update db info in .env file when env vars are updated.
|
|
||||||
* **10.10.22:** - Remove password escape logic which caused problems for a small subset of users.
|
|
||||||
* **20.08.22:** - Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base)).
|
|
||||||
* **14.03.22:** - Add symlinks for theme support.
|
|
||||||
* **11.07.21:** - Rebase to Alpine 3.14.
|
|
||||||
* **12.01.21:** - Remove unused requirement, as of release 0.31.0.
|
|
||||||
* **17.12.20:** - Make APP_URL var required (upstream changes).
|
|
||||||
* **17.09.20:** - Rebase to alpine 3.12. Fix APP_URL setting. Bump php post max and upload max filesizes to 100MB by default.
|
|
||||||
* **19.12.19:** - Rebasing to alpine 3.11.
|
|
||||||
* **26.07.19:** - Use old version of tidyhtml pending upstream fixes.
|
* **26.07.19:** - Use old version of tidyhtml pending upstream fixes.
|
||||||
* **28.06.19:** - Rebasing to alpine 3.10.
|
* **28.06.19:** - Rebasing to alpine 3.10.
|
||||||
* **14.06.19:** - Add wkhtmltopdf to image for PDF rendering.
|
* **14.06.19:** - Add wkhtmltopdf to image for PDF rendering.
|
||||||
|
|||||||
@ -19,11 +19,13 @@ repo_vars:
|
|||||||
- PR_DOCKERHUB_IMAGE = 'lspipepr/bookstack'
|
- PR_DOCKERHUB_IMAGE = 'lspipepr/bookstack'
|
||||||
- DIST_IMAGE = 'alpine'
|
- DIST_IMAGE = 'alpine'
|
||||||
- MULTIARCH = 'true'
|
- MULTIARCH = 'true'
|
||||||
- CI = 'false'
|
- CI = 'true'
|
||||||
- CI_WEB = 'false'
|
- CI_WEB = 'true'
|
||||||
- CI_PORT = '80'
|
- CI_PORT = '80'
|
||||||
- CI_SSL = 'false'
|
- CI_SSL = 'false'
|
||||||
- CI_DELAY = '60'
|
- CI_DELAY = '120'
|
||||||
- CI_DOCKERENV=''
|
- TEST_MYSQL_HOST = credentials('mysql_test_host')
|
||||||
- CI_AUTH = ''
|
- TEST_MYSQL_PASSWORD = credentials('mysql_test_password')
|
||||||
|
- CI_DOCKERENV = 'DB_HOST=${TEST_MYSQL_HOST}|DB_DATABASE=bookstack|DB_USERNAME=root|DB_PASSWORD=${TEST_MYSQL_PASSWORD}'
|
||||||
|
- CI_AUTH = 'user:password'
|
||||||
- CI_WEBPATH = ''
|
- CI_WEBPATH = ''
|
||||||
|
|||||||
@ -1,296 +1,177 @@
|
|||||||
NAME VERSION TYPE
|
alpine-baselayout-3.1.2-r0
|
||||||
Hidden Input 1, 0, 0, 0 binary
|
alpine-keys-2.1-r2
|
||||||
acl-libs 2.3.2-r1 apk
|
alsa-lib-1.1.9-r0
|
||||||
alpine-baselayout 3.7.1-r8 apk
|
apache2-utils-2.4.39-r0
|
||||||
alpine-baselayout-data 3.7.1-r8 apk
|
apk-tools-2.10.4-r2
|
||||||
alpine-keys 2.6-r0 apk
|
apr-1.6.5-r0
|
||||||
alpine-release 3.23.3-r0 apk
|
apr-util-1.6.1-r6
|
||||||
aom-libs 3.13.1-r1 apk
|
argon2-libs-20171227-r2
|
||||||
apache2-utils 2.4.66-r0 apk
|
avahi-libs-0.7-r2
|
||||||
apk-tools 3.0.4-r0 apk
|
bash-5.0.0-r0
|
||||||
apr 1.7.6-r0 apk
|
busybox-1.30.1-r2
|
||||||
apr-util 1.6.3-r2 apk
|
ca-certificates-20190108-r0
|
||||||
argon2-libs 20190702-r5 apk
|
ca-certificates-cacert-20190108-r0
|
||||||
aws/aws-crt-php v1.2.7 php-composer
|
cairo-1.16.0-r2
|
||||||
aws/aws-sdk-php 3.369.36 php-composer
|
cdparanoia-libs-10.2-r7
|
||||||
bacon/bacon-qr-code v3.0.3 php-composer
|
coreutils-8.31-r0
|
||||||
bash 5.3.3-r1 apk
|
cups-libs-2.2.12-r0
|
||||||
brick/math 0.14.8 php-composer
|
curl-7.65.1-r0
|
||||||
brotli-libs 1.2.0-r0 apk
|
db-5.3.28-r1
|
||||||
busybox 1.37.0-r30 apk
|
dbus-libs-1.12.16-r0
|
||||||
busybox-binsh 1.37.0-r30 apk
|
encodings-1.0.4-r1
|
||||||
c-ares 1.34.6-r0 apk
|
eudev-libs-3.2.8-r0
|
||||||
ca-certificates 20251003-r0 apk
|
expat-2.2.7-r0
|
||||||
ca-certificates-bundle 20251003-r0 apk
|
fontconfig-2.13.1-r0
|
||||||
carbonphp/carbon-doctrine-types 3.2.0 php-composer
|
freetype-2.10.0-r0
|
||||||
catatonit 0.2.1-r0 apk
|
fribidi-1.0.5-r1
|
||||||
composer 2.9.5 binary
|
git-2.22.0-r0
|
||||||
coreutils 9.8-r1 apk
|
glib-2.60.4-r0
|
||||||
coreutils-env 9.8-r1 apk
|
gmp-6.1.2-r1
|
||||||
coreutils-fmt 9.8-r1 apk
|
gnutls-3.6.8-r0
|
||||||
coreutils-sha512sum 9.8-r1 apk
|
graphite2-1.3.13-r1
|
||||||
curl 8.17.0-r1 apk
|
gst-plugins-base-1.16.0-r0
|
||||||
dasprid/enum 1.0.7 php-composer
|
gstreamer-1.16.0-r0
|
||||||
dbus-libs 1.16.2-r1 apk
|
harfbuzz-2.5.1-r0
|
||||||
dflydev/dot-access-data v3.0.3 php-composer
|
hicolor-icon-theme-0.17-r0
|
||||||
doctrine/inflector 2.1.0 php-composer
|
icu-libs-64.2-r0
|
||||||
doctrine/lexer 3.0.1 php-composer
|
libacl-2.2.52-r6
|
||||||
dompdf/dompdf v3.1.4 php-composer
|
libattr-2.4.48-r0
|
||||||
dompdf/php-font-lib 1.0.2 php-composer
|
libblkid-2.33.2-r0
|
||||||
dompdf/php-svg-lib 1.0.2 php-composer
|
libbsd-0.9.1-r0
|
||||||
dragonmantank/cron-expression v3.6.0 php-composer
|
libbz2-1.0.6-r7
|
||||||
egulias/email-validator 4.0.4 php-composer
|
libc-utils-0.7.1-r0
|
||||||
encodings 1.1.0-r0 apk
|
libcrypto1.1-1.1.1c-r0
|
||||||
ezyang/htmlpurifier v4.19.0 php-composer
|
libcurl-7.65.1-r0
|
||||||
fakerphp/faker v1.24.1 php-composer
|
libdrm-2.4.98-r0
|
||||||
filp/whoops 2.18.4 php-composer
|
libedit-20190324.3.1-r0
|
||||||
findutils 4.10.0-r0 apk
|
libevdev-1.6.0-r0
|
||||||
firebase/php-jwt v7.0.2 php-composer
|
libevent-2.1.10-r0
|
||||||
font-freefont 20120503-r4 apk
|
libffi-3.2.1-r6
|
||||||
fontconfig 2.17.1-r0 apk
|
libfontenc-1.1.4-r0
|
||||||
freetype 2.14.1-r0 apk
|
libgcc-8.3.0-r0
|
||||||
fruitcake/php-cors v1.4.0 php-composer
|
libgcrypt-1.8.4-r2
|
||||||
gdbm 1.26-r0 apk
|
libgpg-error-1.36-r2
|
||||||
git 2.52.0-r0 apk
|
libice-1.0.9-r3
|
||||||
git-init-template 2.52.0-r0 apk
|
libinput-libs-1.13.2-r0
|
||||||
glib 2.86.3-r0 apk
|
libintl-0.19.8.1-r4
|
||||||
graham-campbell/result-type v1.1.4 php-composer
|
libjpeg-turbo-2.0.2-r0
|
||||||
guzzlehttp/guzzle 7.10.0 php-composer
|
libldap-2.4.48-r0
|
||||||
guzzlehttp/promises 2.3.0 php-composer
|
libmagic-5.37-r0
|
||||||
guzzlehttp/psr7 2.8.0 php-composer
|
libmemcached-libs-1.0.18-r3
|
||||||
guzzlehttp/uri-template v1.0.5 php-composer
|
libmount-2.33.2-r0
|
||||||
hamcrest/hamcrest-php v2.1.1 php-composer
|
libogg-1.3.3-r2
|
||||||
iamcal/sql-parser v0.7 php-composer
|
libpciaccess-0.14-r0
|
||||||
icu-data-full 76.1-r1 apk
|
libpcre2-16-10.33-r0
|
||||||
icu-libs 76.1-r1 apk
|
libpng-1.6.37-r1
|
||||||
intervention/gif 4.2.4 php-composer
|
libressl2.7-libcrypto-2.7.5-r0
|
||||||
intervention/image 3.11.6 php-composer
|
libressl2.7-libssl-2.7.5-r0
|
||||||
itsgoingd/clockwork v5.3.5 php-composer
|
libsasl-2.1.27-r3
|
||||||
jq 1.8.1-r0 apk
|
libseccomp-2.4.1-r0
|
||||||
knplabs/knp-snappy v1.6.0 php-composer
|
libsm-1.2.3-r0
|
||||||
larastan/larastan v3.9.2 php-composer
|
libssl1.1-1.1.1c-r0
|
||||||
laravel/framework v12.52.0 php-composer
|
libstdc++-8.3.0-r0
|
||||||
laravel/prompts v0.3.13 php-composer
|
libtasn1-4.14-r0
|
||||||
laravel/serializable-closure v2.0.9 php-composer
|
libtheora-1.1.1-r14
|
||||||
laravel/socialite v5.24.2 php-composer
|
libtls-standalone-2.9.1-r0
|
||||||
laravel/tinker v2.11.1 php-composer
|
libunistring-0.9.10-r0
|
||||||
league/commonmark 2.8.0 php-composer
|
libuuid-2.33.2-r0
|
||||||
league/config v1.2.0 php-composer
|
libvorbis-1.3.6-r2
|
||||||
league/flysystem 3.31.0 php-composer
|
libwebp-1.0.2-r0
|
||||||
league/flysystem-aws-s3-v3 3.31.0 php-composer
|
libx11-1.6.8-r1
|
||||||
league/flysystem-local 3.31.0 php-composer
|
libxau-1.0.9-r0
|
||||||
league/html-to-markdown 5.1.1 php-composer
|
libxcb-1.13.1-r0
|
||||||
league/mime-type-detection 1.16.0 php-composer
|
libxcomposite-0.4.5-r0
|
||||||
league/oauth1-client v1.11.0 php-composer
|
libxdamage-1.1.5-r0
|
||||||
league/oauth2-client 2.9.0 php-composer
|
libxdmcp-1.1.3-r0
|
||||||
league/uri 7.8.0 php-composer
|
libxext-1.3.4-r0
|
||||||
league/uri-interfaces 7.8.0 php-composer
|
libxfixes-5.0.3-r2
|
||||||
libapk 3.0.4-r0 apk
|
libxft-2.3.3-r0
|
||||||
libattr 2.5.2-r2 apk
|
libxkbcommon-0.8.4-r1
|
||||||
libavif 1.3.0-r0 apk
|
libxkbcommon-x11-0.8.4-r1
|
||||||
libblkid 2.41.2-r0 apk
|
libxml2-2.9.9-r2
|
||||||
libbsd 0.12.2-r0 apk
|
libxpm-3.5.12-r0
|
||||||
libbz2 1.0.8-r6 apk
|
libxrender-0.9.10-r3
|
||||||
libcrypto3 3.5.5-r0 apk
|
libxshmfence-1.3-r0
|
||||||
libcurl 8.17.0-r1 apk
|
libxslt-1.1.33-r1
|
||||||
libdav1d 1.5.2-r0 apk
|
libxt-1.1.5-r2
|
||||||
libeconf 0.8.3-r0 apk
|
libxv-1.0.11-r2
|
||||||
libedit 20251016.3.1-r0 apk
|
libxxf86vm-1.1.4-r2
|
||||||
libevent 2.1.12-r8 apk
|
linux-pam-1.3.0-r1
|
||||||
libexpat 2.7.4-r0 apk
|
logrotate-3.15.0-r0
|
||||||
libffi 3.5.2-r0 apk
|
memcached-1.5.16-r0
|
||||||
libfontenc 1.1.8-r0 apk
|
mesa-19.0.6-r0
|
||||||
libgcc 15.2.0-r2 apk
|
mesa-egl-19.0.6-r0
|
||||||
libice 1.1.2-r0 apk
|
mesa-gbm-19.0.6-r0
|
||||||
libidn2 2.3.8-r0 apk
|
mesa-gl-19.0.6-r0
|
||||||
libintl 0.24.1-r1 apk
|
mesa-glapi-19.0.6-r0
|
||||||
libjpeg-turbo 3.1.2-r0 apk
|
mkfontscale-1.2.1-r1
|
||||||
libldap 2.6.10-r0 apk
|
mtdev-1.1.5-r2
|
||||||
libmd 1.1.0-r0 apk
|
musl-1.1.22-r3
|
||||||
libmemcached-libs 1.1.4-r1 apk
|
musl-utils-1.1.22-r3
|
||||||
libmount 2.41.2-r0 apk
|
nano-4.3-r0
|
||||||
libncursesw 6.5_p20251123-r0 apk
|
ncurses-libs-6.1_p20190518-r0
|
||||||
libpcre2-16 10.47-r0 apk
|
ncurses-terminfo-6.1_p20190518-r0
|
||||||
libpng 1.6.54-r0 apk
|
ncurses-terminfo-base-6.1_p20190518-r0
|
||||||
libproc2 4.0.5-r0 apk
|
netcat-openbsd-1.130-r1
|
||||||
libpsl 0.21.5-r3 apk
|
nettle-3.4.1-r1
|
||||||
libsasl 2.1.28-r9 apk
|
nghttp2-libs-1.38.0-r0
|
||||||
libseccomp 2.6.0-r1 apk
|
nginx-1.16.1-r0
|
||||||
libsharpyuv 1.6.0-r0 apk
|
openssl-1.1.1c-r0
|
||||||
libsm 1.2.6-r0 apk
|
opus-1.3.1-r0
|
||||||
libssl3 3.5.5-r0 apk
|
orc-0.4.29-r0
|
||||||
libstdc++ 15.2.0-r2 apk
|
p11-kit-0.23.16.1-r0
|
||||||
libunistring 1.4.1-r0 apk
|
pango-1.42.4-r2
|
||||||
libuuid 2.41.2-r0 apk
|
pcre-8.43-r0
|
||||||
libwebp 1.6.0-r0 apk
|
pcre2-10.33-r0
|
||||||
libx11 1.8.12-r1 apk
|
php7-7.3.8-r0
|
||||||
libxau 1.0.12-r0 apk
|
php7-common-7.3.8-r0
|
||||||
libxcb 1.17.0-r1 apk
|
php7-ctype-7.3.9-r0
|
||||||
libxdmcp 1.1.5-r1 apk
|
php7-curl-7.3.9-r0
|
||||||
libxext 1.3.6-r2 apk
|
php7-dom-7.3.9-r0
|
||||||
libxml2 2.13.9-r0 apk
|
php7-fileinfo-7.3.8-r0
|
||||||
libxpm 3.5.17-r0 apk
|
php7-fpm-7.3.8-r0
|
||||||
libxt 1.3.1-r0 apk
|
php7-gd-7.3.9-r0
|
||||||
libyuv 0.0.1887.20251502-r1 apk
|
php7-json-7.3.8-r0
|
||||||
libzip 1.11.4-r1 apk
|
php7-ldap-7.3.9-r0
|
||||||
linux-pam 1.7.1-r2 apk
|
php7-mbstring-7.3.8-r0
|
||||||
logrotate 3.22.0-r0 apk
|
php7-mysqlnd-7.3.9-r0
|
||||||
mariadb-client 11.4.9-r0 apk
|
php7-openssl-7.3.8-r0
|
||||||
mariadb-common 11.4.9-r0 apk
|
php7-pdo-7.3.9-r0
|
||||||
masterminds/html5 2.10.0 php-composer
|
php7-pdo_mysql-7.3.9-r0
|
||||||
memcached 1.6.39-r0 apk
|
php7-pecl-igbinary-3.0.1-r1
|
||||||
mkfontscale 1.2.3-r1 apk
|
php7-pecl-memcached-3.1.3-r2
|
||||||
mockery/mockery 1.6.12 php-composer
|
php7-phar-7.3.9-r0
|
||||||
monolog/monolog 3.10.0 php-composer
|
php7-session-7.3.8-r0
|
||||||
mtdowling/jmespath.php 2.8.0 php-composer
|
php7-simplexml-7.3.8-r0
|
||||||
musl 1.2.5-r21 apk
|
php7-tidy-7.3.9-r0
|
||||||
musl-utils 1.2.5-r21 apk
|
php7-tokenizer-7.3.9-r0
|
||||||
myclabs/deep-copy 1.13.4 php-composer
|
php7-xml-7.3.8-r0
|
||||||
nano 8.7-r0 apk
|
php7-xmlwriter-7.3.8-r0
|
||||||
ncurses-terminfo-base 6.5_p20251123-r0 apk
|
pixman-0.38.4-r0
|
||||||
nesbot/carbon 3.11.1 php-composer
|
popt-1.16-r7
|
||||||
netcat-openbsd 1.234.1-r0 apk
|
qt5-qtbase-5.12.4-r0
|
||||||
nette/schema v1.3.4 php-composer
|
qt5-qtbase-x11-5.12.4-r0
|
||||||
nette/utils v4.1.3 php-composer
|
qt5-qtdeclarative-5.12.4-r0
|
||||||
nghttp2-libs 1.68.0-r0 apk
|
qt5-qtsvg-5.12.4-r0
|
||||||
nghttp3 1.13.1-r0 apk
|
qt5-qtwebkit-5.9.1-r6
|
||||||
nginx 1.28.2-r0 apk
|
readline-8.0.0-r0
|
||||||
nikic/php-parser v5.7.0 php-composer
|
scanelf-1.2.3-r0
|
||||||
nunomaduro/collision v8.9.1 php-composer
|
shadow-4.6-r2
|
||||||
nunomaduro/termwind v2.4.0 php-composer
|
sqlite-libs-3.28.0-r0
|
||||||
onelogin/php-saml 4.3.1 php-composer
|
ssl_client-1.30.1-r2
|
||||||
oniguruma 6.9.10-r0 apk
|
tar-1.32-r0
|
||||||
openssl 3.5.5-r0 apk
|
tidyhtml-libs-5.6.0-r0
|
||||||
paragonie/constant_time_encoding v3.1.3 php-composer
|
ttf-freefont-20120503-r1
|
||||||
paragonie/random_compat v9.99.100 php-composer
|
tzdata-2019a-r0
|
||||||
pcre2 10.47-r0 apk
|
wayland-libs-client-1.17.0-r0
|
||||||
phar-io/manifest 2.0.4 php-composer
|
wayland-libs-egl-1.17.0-r0
|
||||||
phar-io/version 3.2.1 php-composer
|
wayland-libs-server-1.17.0-r0
|
||||||
php85 8.5.2-r0 apk
|
wkhtmltopdf-0.12.5-r0
|
||||||
php85-common 8.5.2-r0 apk
|
xcb-util-0.4.0-r1
|
||||||
php85-ctype 8.5.2-r0 apk
|
xcb-util-image-0.4.0-r1
|
||||||
php85-curl 8.5.2-r0 apk
|
xcb-util-keysyms-0.4.0-r1
|
||||||
php85-dom 8.5.2-r0 apk
|
xcb-util-renderutil-0.3.9-r1
|
||||||
php85-exif 8.5.2-r0 apk
|
xcb-util-wm-0.4.1-r1
|
||||||
php85-fileinfo 8.5.2-r0 apk
|
xz-5.2.4-r0
|
||||||
php85-fpm 8.5.2-r0 apk
|
xz-libs-5.2.4-r0
|
||||||
php85-gd 8.5.2-r0 apk
|
zlib-1.2.11-r1
|
||||||
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
|
|
||||||
psr/clock 1.0.0 php-composer
|
|
||||||
psr/container 2.0.2 php-composer
|
|
||||||
psr/event-dispatcher 1.0.0 php-composer
|
|
||||||
psr/http-client 1.0.3 php-composer
|
|
||||||
psr/http-factory 1.1.0 php-composer
|
|
||||||
psr/http-message 2.0 php-composer
|
|
||||||
psr/log 3.0.2 php-composer
|
|
||||||
psr/simple-cache 3.0.0 php-composer
|
|
||||||
psy/psysh v0.12.20 php-composer
|
|
||||||
qt5-qtbase 5.15.10_git20230714-r4 apk
|
|
||||||
ralouphie/getallheaders 3.0.3 php-composer
|
|
||||||
ramsey/collection 2.1.1 php-composer
|
|
||||||
ramsey/uuid 4.9.2 php-composer
|
|
||||||
readline 8.3.1-r0 apk
|
|
||||||
robrichards/xmlseclibs 3.1.4 php-composer
|
|
||||||
sabberworm/php-css-parser v9.1.0 php-composer
|
|
||||||
scanelf 1.3.8-r2 apk
|
|
||||||
sebastian/cli-parser 3.0.2 php-composer
|
|
||||||
sebastian/code-unit 3.0.3 php-composer
|
|
||||||
sebastian/code-unit-reverse-lookup 4.0.1 php-composer
|
|
||||||
sebastian/comparator 6.3.3 php-composer
|
|
||||||
sebastian/complexity 4.0.1 php-composer
|
|
||||||
sebastian/diff 6.0.2 php-composer
|
|
||||||
sebastian/environment 7.2.1 php-composer
|
|
||||||
sebastian/exporter 6.3.2 php-composer
|
|
||||||
sebastian/global-state 7.0.2 php-composer
|
|
||||||
sebastian/lines-of-code 3.0.1 php-composer
|
|
||||||
sebastian/object-enumerator 6.0.1 php-composer
|
|
||||||
sebastian/object-reflector 4.0.1 php-composer
|
|
||||||
sebastian/recursion-context 6.0.3 php-composer
|
|
||||||
sebastian/type 5.1.3 php-composer
|
|
||||||
sebastian/version 5.0.2 php-composer
|
|
||||||
shadow 4.18.0-r0 apk
|
|
||||||
skalibs-libs 2.14.4.0-r0 apk
|
|
||||||
socialiteproviders/discord 4.2.0 php-composer
|
|
||||||
socialiteproviders/gitlab 4.1.0 php-composer
|
|
||||||
socialiteproviders/manager v4.8.1 php-composer
|
|
||||||
socialiteproviders/microsoft-azure 5.2.0 php-composer
|
|
||||||
socialiteproviders/okta 4.5.0 php-composer
|
|
||||||
socialiteproviders/twitch 5.4.0 php-composer
|
|
||||||
squizlabs/php_codesniffer 4.0.1 php-composer
|
|
||||||
ssddanbrown/asserthtml v3.1.0 php-composer
|
|
||||||
ssddanbrown/htmldiff v2.0.0 php-composer
|
|
||||||
ssl_client 1.37.0-r30 apk
|
|
||||||
staabm/side-effects-detector 1.0.5 php-composer
|
|
||||||
symfony/clock v7.4.0 php-composer
|
|
||||||
symfony/console v7.4.4 php-composer
|
|
||||||
symfony/css-selector v7.4.0 php-composer
|
|
||||||
symfony/deprecation-contracts v3.6.0 php-composer
|
|
||||||
symfony/dom-crawler v7.4.4 php-composer
|
|
||||||
symfony/error-handler v7.4.4 php-composer
|
|
||||||
symfony/event-dispatcher v7.4.4 php-composer
|
|
||||||
symfony/event-dispatcher-contracts v3.6.0 php-composer
|
|
||||||
symfony/filesystem v7.4.0 php-composer
|
|
||||||
symfony/finder v7.4.5 php-composer
|
|
||||||
symfony/http-foundation v7.4.5 php-composer
|
|
||||||
symfony/http-kernel v7.4.5 php-composer
|
|
||||||
symfony/mailer v7.4.4 php-composer
|
|
||||||
symfony/mime v7.4.5 php-composer
|
|
||||||
symfony/polyfill-ctype v1.33.0 php-composer
|
|
||||||
symfony/polyfill-intl-grapheme v1.33.0 php-composer
|
|
||||||
symfony/polyfill-intl-idn v1.33.0 php-composer
|
|
||||||
symfony/polyfill-intl-normalizer v1.33.0 php-composer
|
|
||||||
symfony/polyfill-mbstring v1.33.0 php-composer
|
|
||||||
symfony/polyfill-php80 v1.33.0 php-composer
|
|
||||||
symfony/polyfill-php83 v1.33.0 php-composer
|
|
||||||
symfony/polyfill-php84 v1.33.0 php-composer
|
|
||||||
symfony/polyfill-php85 v1.33.0 php-composer
|
|
||||||
symfony/polyfill-uuid v1.33.0 php-composer
|
|
||||||
symfony/process v7.4.5 php-composer
|
|
||||||
symfony/routing v7.4.4 php-composer
|
|
||||||
symfony/service-contracts v3.6.1 php-composer
|
|
||||||
symfony/string v7.4.4 php-composer
|
|
||||||
symfony/translation v7.4.4 php-composer
|
|
||||||
symfony/translation-contracts v3.6.1 php-composer
|
|
||||||
symfony/uid v7.4.4 php-composer
|
|
||||||
symfony/var-dumper v7.4.4 php-composer
|
|
||||||
thecodingmachine/safe v3.4.0 php-composer
|
|
||||||
theseer/tokenizer 1.3.1 php-composer
|
|
||||||
tijsverkoyen/css-to-inline-styles v2.4.0 php-composer
|
|
||||||
tzdata 2025c-r0 apk
|
|
||||||
utmps-libs 0.1.3.1-r0 apk
|
|
||||||
vlucas/phpdotenv v5.6.3 php-composer
|
|
||||||
voku/portable-ascii 2.0.3 php-composer
|
|
||||||
xemlock/htmlpurifier-html5 v0.1.12 php-composer
|
|
||||||
xz-libs 5.8.2-r0 apk
|
|
||||||
zlib 1.3.1-r2 apk
|
|
||||||
zstd-libs 1.5.7-r2 apk
|
|
||||||
|
|||||||
216
readme-vars.yml
216
readme-vars.yml
@ -3,173 +3,111 @@
|
|||||||
# project information
|
# project information
|
||||||
project_name: bookstack
|
project_name: bookstack
|
||||||
project_url: "https://github.com/BookStackApp/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_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
|
||||||
project_categories: "Content Management"
|
|
||||||
project_blurb: |
|
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.
|
[{{ project_name|capitalize }}]({{ project_url }}) is a free and open source Wiki designed for creating beautiful documentation. Feautring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
|
||||||
|
|
||||||
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.
|
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
|
For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
|
||||||
|
|
||||||
# supported architectures
|
# supported architectures
|
||||||
available_architectures:
|
available_architectures:
|
||||||
- {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
|
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
|
||||||
- {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
|
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
|
||||||
|
- { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}
|
||||||
|
|
||||||
# container parameters
|
# container parameters
|
||||||
param_container_name: "{{ project_name }}"
|
param_container_name: "{{ project_name }}"
|
||||||
param_usage_include_vols: true
|
param_usage_include_vols: true
|
||||||
param_volumes:
|
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 data>", desc: "this will store any uploaded data on the docker host" }
|
||||||
param_usage_include_env: true
|
param_usage_include_env: true
|
||||||
param_env_vars:
|
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: "DB_HOST", env_value: "<yourdbhost>", desc: "for specifying the database host" }
|
||||||
- {env_var: "APP_KEY", env_value: "", desc: "Session encryption key. You will need to generate this with `docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey`"}
|
- { env_var: "DB_USER", env_value: "<yourdbuser>", desc: "for specifying the database user" }
|
||||||
- {env_var: "DB_HOST", env_value: "", desc: "The database instance hostname"}
|
- { env_var: "DB_PASS", env_value: "<yourdbpass>", desc: "for specifying the database password" }
|
||||||
- {env_var: "DB_PORT", env_value: "3306", desc: "Database port"}
|
- { env_var: "DB_DATABASE", env_value: "bookstackapp", desc: "for specifying the database to be used" }
|
||||||
- {env_var: "DB_USERNAME", env_value: "", desc: "Database user"}
|
|
||||||
- {env_var: "DB_PASSWORD", env_value: "", desc: "Database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.)"}
|
|
||||||
- {env_var: "DB_DATABASE", env_value: "", desc: "Database name"}
|
|
||||||
param_usage_include_ports: true
|
param_usage_include_ports: true
|
||||||
param_ports:
|
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_usage_include_env: true
|
||||||
opt_param_env_vars:
|
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)."}
|
- { env_var: "APP_URL", env_value: "http://your.site.here.xyz", desc: "for specifying the url your application will be accessed on (required for correct operation of reverse proxy)"}
|
||||||
readonly_supported: true
|
|
||||||
readonly_message: |
|
custom_compose: |
|
||||||
* `/tmp` must be mounted to tmpfs
|
---
|
||||||
|
version: "2"
|
||||||
|
services:
|
||||||
|
bookstack:
|
||||||
|
image: linuxserver/bookstack
|
||||||
|
container_name: bookstack
|
||||||
|
environment:
|
||||||
|
- PUID=1000
|
||||||
|
- PGID=1000
|
||||||
|
- DB_HOST=bookstack_db
|
||||||
|
- DB_USER=bookstack
|
||||||
|
- DB_PASS=<yourdbpass>
|
||||||
|
- DB_DATABASE=bookstackapp
|
||||||
|
volumes:
|
||||||
|
- <path to data>:/config
|
||||||
|
ports:
|
||||||
|
- 6875:80
|
||||||
|
restart: unless-stopped
|
||||||
|
depends_on:
|
||||||
|
- bookstack_db
|
||||||
|
bookstack_db:
|
||||||
|
image: linuxserver/mariadb
|
||||||
|
container_name: bookstack_db
|
||||||
|
environment:
|
||||||
|
- PUID=1000
|
||||||
|
- PGID=1000
|
||||||
|
- MYSQL_ROOT_PASSWORD=<yourdbpass>
|
||||||
|
- TZ=Europe/London
|
||||||
|
- MYSQL_DATABASE=bookstackapp
|
||||||
|
- MYSQL_USER=bookstack
|
||||||
|
- MYSQL_PASSWORD=<yourdbpass>
|
||||||
|
volumes:
|
||||||
|
- <path to data>:/config
|
||||||
|
restart: unless-stopped
|
||||||
|
|
||||||
# application setup block
|
# application setup block
|
||||||
app_setup_block_enabled: true
|
app_setup_block_enabled: true
|
||||||
app_setup_block: |
|
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.
|
||||||
|
|
||||||
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.
|
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/.
|
||||||
|
|
||||||
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/.
|
|
||||||
|
If you intend to use this application behind a subfolder reverse proxy, such as our LetsEncrypt container or Traefik you will need to make sure that the `APP_URL` environment variable is set, or it will not work
|
||||||
|
|
||||||
### BookStack File & Directory Paths
|
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
|
||||||
|
|
||||||
This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the `/config` folder so that they are persistent & accessible when the `/config` container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation.
|
|
||||||
|
|
||||||
Below is a mapping of container `/config` paths to those relative within a BookStack install directory:
|
|
||||||
|
|
||||||
- **/config container path** => **BookStack relative path**
|
|
||||||
- `/config/www/.env` => `.env`
|
|
||||||
- `/config/log/bookstack/laravel.log` => `storage/logs/laravel.log`
|
|
||||||
- `/config/backups/` => `storage/backups/`
|
|
||||||
- `/config/www/files/` => `storage/uploads/files/`
|
|
||||||
- `/config/www/images/` => `storage/uploads/images/`
|
|
||||||
- `/config/www/themes/` => `themes/`
|
|
||||||
- `/config/www/uploads/` => `public/uploads/`
|
|
||||||
|
|
||||||
### Changing APP_URL
|
|
||||||
|
|
||||||
If you change the APP_URL after initial install, you should run the following line from your host terminal to update the database URL entries:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
docker exec -it bookstack php /app/www/artisan bookstack:update-url ${OLD_URL} ${NEW_URL}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Advanced Users (full control over the .env file)
|
### 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, or APP_URL. The container will copy an .env file to /config/www/.env on your host system for you to edit. When you create the container, do not set any arguments for any SQL settings, or APP_URL. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
|
||||||
|
|
||||||
|
#### PDF Rendering
|
||||||
|
[wkhtmltopdf](https://wkhtmltopdf.org/) is available to use as an alternative PDF rendering generator as described at https://www.bookstackapp.com/docs/admin/pdf-rendering/.
|
||||||
|
|
||||||
|
The path to wkhtmltopdf in this image to include in your .env file is `/usr/bin/wkhtmltopdf`.
|
||||||
|
|
||||||
If you wish to use the extra functionality of BookStack such as email, LDAP and so on you will need to set additional environment variables or make your own .env file with guidance from the BookStack documentation.
|
|
||||||
|
|
||||||
The container will copy an exemplary .env file to /config/www/.env on your host system for you to use.
|
|
||||||
# init diagram
|
|
||||||
init_diagram: |
|
|
||||||
"bookstack:latest": {
|
|
||||||
docker-mods
|
|
||||||
base {
|
|
||||||
fix-attr +\nlegacy cont-init
|
|
||||||
}
|
|
||||||
docker-mods -> base
|
|
||||||
legacy-services
|
|
||||||
custom services
|
|
||||||
init-services -> legacy-services
|
|
||||||
init-services -> custom services
|
|
||||||
custom services -> legacy-services
|
|
||||||
legacy-services -> ci-service-check
|
|
||||||
init-migrations -> init-adduser
|
|
||||||
init-nginx-end -> init-bookstack-config
|
|
||||||
init-nginx-end -> init-config
|
|
||||||
init-os-end -> init-config
|
|
||||||
init-bookstack-config -> init-config-end
|
|
||||||
init-config -> init-config-end
|
|
||||||
init-crontab-config -> init-config-end
|
|
||||||
init-config -> init-crontab-config
|
|
||||||
init-mods-end -> init-custom-files
|
|
||||||
init-adduser -> init-device-perms
|
|
||||||
base -> init-envfile
|
|
||||||
init-os-end -> init-folders
|
|
||||||
init-php -> init-keygen
|
|
||||||
base -> init-migrations
|
|
||||||
init-config-end -> init-mods
|
|
||||||
init-mods-package-install -> init-mods-end
|
|
||||||
init-mods -> init-mods-package-install
|
|
||||||
init-samples -> init-nginx
|
|
||||||
init-version-checks -> init-nginx-end
|
|
||||||
init-adduser -> init-os-end
|
|
||||||
init-device-perms -> init-os-end
|
|
||||||
init-envfile -> init-os-end
|
|
||||||
init-keygen -> init-permissions
|
|
||||||
init-nginx -> init-php
|
|
||||||
init-folders -> init-samples
|
|
||||||
init-custom-files -> init-services
|
|
||||||
init-permissions -> init-version-checks
|
|
||||||
init-services -> svc-cron
|
|
||||||
svc-cron -> legacy-services
|
|
||||||
init-services -> svc-memcached
|
|
||||||
svc-memcached -> legacy-services
|
|
||||||
init-services -> svc-nginx
|
|
||||||
svc-nginx -> legacy-services
|
|
||||||
init-services -> svc-php-fpm
|
|
||||||
svc-php-fpm -> legacy-services
|
|
||||||
init-services -> svc-queue-worker
|
|
||||||
svc-queue-worker -> legacy-services
|
|
||||||
}
|
|
||||||
Base Images: {
|
|
||||||
"baseimage-alpine-nginx:3.23" <- "baseimage-alpine:3.23"
|
|
||||||
}
|
|
||||||
"bookstack:latest" <- Base Images
|
|
||||||
# changelog
|
# changelog
|
||||||
changelogs:
|
changelogs:
|
||||||
- {date: "28.12.25:", desc: "Rebase to Alpine 3.23."}
|
- { date: "26.07.19:", desc: "Use old version of tidyhtml pending upstream fixes." }
|
||||||
- {date: "05.07.25:", desc: "Rebase to Alpine 3.22."}
|
- { date: "28.06.19:", desc: "Rebasing to alpine 3.10." }
|
||||||
- {date: "04.01.25:", desc: "Add php-opcache."}
|
- { date: "14.06.19:", desc: "Add wkhtmltopdf to image for PDF rendering." }
|
||||||
- {date: "17.12.24:", desc: "Rebase to Alpine 3.21."}
|
- { date: "20.04.19:", desc: "Rebase to Alpine 3.9, add MySQL init logic." }
|
||||||
- {date: "11.10.24:", desc: "Default to environment config over .env file config."}
|
- { date: "22.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
|
||||||
- {date: "06.09.24:", desc: "Add php-exif for reading image EXIF data."}
|
- { date: "20.01.19:", desc: "Added php7-curl"}
|
||||||
- {date: "27.05.24:", desc: "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings."}
|
- { date: "04.11.18:", desc: "Added php7-ldap"}
|
||||||
- {date: "25.01.24:", desc: "Existing users should update: site-confs/default.conf - Cleanup default site conf."}
|
- { date: "15.10.18:", desc: "Changed functionality for advanced users"}
|
||||||
- {date: "23.12.23:", desc: "Rebase to Alpine 3.19 with php 8.3."}
|
- { date: "08.10.18:", desc: "Advanced mode, symlink changes, sed fixing, docs updated, added some composer files"}
|
||||||
- {date: "31.10.23:", desc: "Further sanitize sed replace."}
|
- { date: "23.09.28:", desc: "Updates pre-release"}
|
||||||
- {date: "07.06.23:", desc: "Add mariadb-client for bookstack-system-cli support."}
|
- { date: "02.07.18:", desc: "Initial Release." }
|
||||||
- {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
|
|
||||||
39
root/defaults/default
Normal file
39
root/defaults/default
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
## Version 2018/03/06 - Changelog: https://github.com/linuxserver/docker-heimdall/commits/master/root/defaults/default
|
||||||
|
|
||||||
|
server {
|
||||||
|
listen 80 default_server;
|
||||||
|
|
||||||
|
listen 443 ssl;
|
||||||
|
|
||||||
|
root /var/www/html/public;
|
||||||
|
index index.php index.html index.htm;
|
||||||
|
|
||||||
|
server_name _;
|
||||||
|
|
||||||
|
ssl_certificate /config/keys/cert.crt;
|
||||||
|
ssl_certificate_key /config/keys/cert.key;
|
||||||
|
|
||||||
|
client_max_body_size 0;
|
||||||
|
|
||||||
|
error_page 599 = @noauth;
|
||||||
|
|
||||||
|
location @noauth {
|
||||||
|
try_files $uri $uri/ /index.php?$args;
|
||||||
|
}
|
||||||
|
|
||||||
|
location / {
|
||||||
|
try_files $uri $uri/ /index.php?$query_string;
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
location ~ \.php$ {
|
||||||
|
fastcgi_split_path_info ^(.+\.php)(/.+)$;
|
||||||
|
# With php5-cgi alone:
|
||||||
|
fastcgi_pass 127.0.0.1:9000;
|
||||||
|
# With php5-fpm:
|
||||||
|
#fastcgi_pass unix:/var/run/php5-fpm.sock;
|
||||||
|
fastcgi_index index.php;
|
||||||
|
include /etc/nginx/fastcgi_params;
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
98
root/defaults/nginx.conf
Normal file
98
root/defaults/nginx.conf
Normal file
@ -0,0 +1,98 @@
|
|||||||
|
user abc;
|
||||||
|
worker_processes 4;
|
||||||
|
pid /run/nginx.pid;
|
||||||
|
include /etc/nginx/modules/*.conf;
|
||||||
|
|
||||||
|
events {
|
||||||
|
worker_connections 768;
|
||||||
|
# multi_accept on;
|
||||||
|
}
|
||||||
|
|
||||||
|
http {
|
||||||
|
|
||||||
|
##
|
||||||
|
# Basic Settings
|
||||||
|
##
|
||||||
|
|
||||||
|
sendfile on;
|
||||||
|
tcp_nopush on;
|
||||||
|
tcp_nodelay on;
|
||||||
|
keepalive_timeout 65;
|
||||||
|
types_hash_max_size 2048;
|
||||||
|
# server_tokens off;
|
||||||
|
|
||||||
|
# server_names_hash_bucket_size 64;
|
||||||
|
# server_name_in_redirect off;
|
||||||
|
|
||||||
|
client_max_body_size 0;
|
||||||
|
|
||||||
|
include /etc/nginx/mime.types;
|
||||||
|
default_type application/octet-stream;
|
||||||
|
|
||||||
|
##
|
||||||
|
# Logging Settings
|
||||||
|
##
|
||||||
|
|
||||||
|
access_log /config/log/nginx/access.log;
|
||||||
|
error_log /config/log/nginx/error.log;
|
||||||
|
|
||||||
|
##
|
||||||
|
# Gzip Settings
|
||||||
|
##
|
||||||
|
|
||||||
|
gzip on;
|
||||||
|
gzip_disable "msie6";
|
||||||
|
|
||||||
|
# gzip_vary on;
|
||||||
|
# gzip_proxied any;
|
||||||
|
# gzip_comp_level 6;
|
||||||
|
# gzip_buffers 16 8k;
|
||||||
|
# gzip_http_version 1.1;
|
||||||
|
# gzip_types text/plain text/css application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript;
|
||||||
|
|
||||||
|
##
|
||||||
|
# nginx-naxsi config
|
||||||
|
##
|
||||||
|
# Uncomment it if you installed nginx-naxsi
|
||||||
|
##
|
||||||
|
|
||||||
|
#include /etc/nginx/naxsi_core.rules;
|
||||||
|
|
||||||
|
##
|
||||||
|
# nginx-passenger config
|
||||||
|
##
|
||||||
|
# Uncomment it if you installed nginx-passenger
|
||||||
|
##
|
||||||
|
|
||||||
|
#passenger_root /usr;
|
||||||
|
#passenger_ruby /usr/bin/ruby;
|
||||||
|
|
||||||
|
##
|
||||||
|
# Virtual Host Configs
|
||||||
|
##
|
||||||
|
include /etc/nginx/conf.d/*.conf;
|
||||||
|
include /config/nginx/site-confs/*;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#mail {
|
||||||
|
# # See sample authentication script at:
|
||||||
|
# # http://wiki.nginx.org/ImapAuthenticateWithApachePhpScript
|
||||||
|
#
|
||||||
|
# # auth_http localhost/auth.php;
|
||||||
|
# # pop3_capabilities "TOP" "USER";
|
||||||
|
# # imap_capabilities "IMAP4rev1" "UIDPLUS";
|
||||||
|
#
|
||||||
|
# server {
|
||||||
|
# listen localhost:110;
|
||||||
|
# protocol pop3;
|
||||||
|
# proxy on;
|
||||||
|
# }
|
||||||
|
#
|
||||||
|
# server {
|
||||||
|
# listen localhost:143;
|
||||||
|
# protocol imap;
|
||||||
|
# proxy on;
|
||||||
|
# }
|
||||||
|
#}
|
||||||
|
daemon off;
|
||||||
84
root/etc/cont-init.d/50-config
Normal file
84
root/etc/cont-init.d/50-config
Normal file
@ -0,0 +1,84 @@
|
|||||||
|
#!/usr/bin/with-contenv bash
|
||||||
|
|
||||||
|
# create directory structure
|
||||||
|
mkdir -p \
|
||||||
|
/config/www/{uploads,files,images}
|
||||||
|
|
||||||
|
# check for .env and copy default if needed
|
||||||
|
[[ ! -f "/config/www/.env" ]] && \
|
||||||
|
cp /var/www/html/.env.example /config/www/.env
|
||||||
|
|
||||||
|
# create symlinks
|
||||||
|
symlinks=( \
|
||||||
|
/var/www/html/storage/uploads/files \
|
||||||
|
/var/www/html/storage/uploads/images \
|
||||||
|
/var/www/html/public/uploads \
|
||||||
|
/var/www/html/.env \
|
||||||
|
/var/www/html/storage/logs/laravel.log
|
||||||
|
)
|
||||||
|
|
||||||
|
for i in "${symlinks[@]}"
|
||||||
|
do
|
||||||
|
[[ -e "$i" && ! -L "$i" ]] && rm -rf "$i"
|
||||||
|
[[ ! -L "$i" ]] && ln -s /config/www/"$(basename "$i")" "$i"
|
||||||
|
done
|
||||||
|
|
||||||
|
# Create API key if needed
|
||||||
|
if [ ! -f "/config/BOOKSTACK_APP_KEY.txt" ];
|
||||||
|
then
|
||||||
|
echo "Generating BookStack app key for first run"
|
||||||
|
key=$(php /var/www/html/artisan key:generate --show)
|
||||||
|
echo $key > /config/BOOKSTACK_APP_KEY.txt
|
||||||
|
echo "App Key set to $key you can modify the file to update /config/BOOKSTACK_APP_KEY.txt"
|
||||||
|
elif [ -f "/config/BOOKSTACK_APP_KEY.txt" ];
|
||||||
|
then
|
||||||
|
echo "App Key found - setting variable for seds"
|
||||||
|
key=$(cat /config/BOOKSTACK_APP_KEY.txt)
|
||||||
|
fi
|
||||||
|
|
||||||
|
# .env file setup
|
||||||
|
# check for the default app key or if it has been updated
|
||||||
|
if grep -Fxq "APP_KEY=SomeRandomString" /config/www/.env || \
|
||||||
|
! grep -Fxq "APP_KEY=${key}" /config/www/.env; then
|
||||||
|
sed -i "s#^APP_KEY=.*#APP_KEY=${key}#" /config/www/.env
|
||||||
|
fi
|
||||||
|
# check to see if db_user is set, if it is then run seds and if not then leave them
|
||||||
|
if [ "${DB_USER}" ];
|
||||||
|
then
|
||||||
|
echo "Running config - db_user set"
|
||||||
|
sed -i "s/DB_HOST=localhost/DB_HOST=${DB_HOST}/g" /config/www/.env
|
||||||
|
sed -i "s/DB_DATABASE=database_database/DB_DATABASE=${DB_DATABASE}/g" /config/www/.env
|
||||||
|
sed -i "s/DB_USERNAME=database_username/DB_USERNAME=${DB_USER}/g" /config/www/.env
|
||||||
|
sed -i "s/DB_PASSWORD=database_user_password/DB_PASSWORD=${DB_PASS}/g" /config/www/.env
|
||||||
|
fi
|
||||||
|
|
||||||
|
# set appurl if detected
|
||||||
|
[[ "${APP_URL}" ]] && sed -i "s,#\sAPP_URL.*,APP_URL=${APP_URL},g" /config/www/.env
|
||||||
|
|
||||||
|
# check for the mysql endpoint for 30 seconds
|
||||||
|
END=$((SECONDS+30))
|
||||||
|
while [ ${SECONDS} -lt ${END} ] && [ "${DB_HOST}" ];
|
||||||
|
do
|
||||||
|
/usr/bin/nc -z ${DB_HOST} 3306 && \
|
||||||
|
if [ ! -z "$(/usr/bin/nc -w1 ${DB_HOST} 3306)" ];
|
||||||
|
then
|
||||||
|
[ ! -z "${RUN}" ] && break
|
||||||
|
RUN="RAN"
|
||||||
|
# we sleep here again due to first run init on DB containers
|
||||||
|
[ ! -f /dbwait.lock ] && sleep 5
|
||||||
|
else
|
||||||
|
sleep 1
|
||||||
|
fi
|
||||||
|
sleep 1
|
||||||
|
done
|
||||||
|
|
||||||
|
# update database - will set up database if fresh, or, migrate existing
|
||||||
|
php /var/www/html/artisan migrate --force
|
||||||
|
|
||||||
|
# set permissions
|
||||||
|
chown -R abc:abc \
|
||||||
|
/config \
|
||||||
|
/var/www/
|
||||||
|
|
||||||
|
# set lockfile to avoid DB waits for this specific container
|
||||||
|
touch /dbwait.lock
|
||||||
@ -1,63 +0,0 @@
|
|||||||
#!/usr/bin/with-contenv bash
|
|
||||||
# shellcheck shell=bash
|
|
||||||
|
|
||||||
# create directory structure
|
|
||||||
mkdir -p \
|
|
||||||
/config/www/{uploads,files,images,themes} \
|
|
||||||
/config/www/framework/{cache,sessions,views,purifier} \
|
|
||||||
/config/backups \
|
|
||||||
/config/log/bookstack
|
|
||||||
|
|
||||||
if [[ ! -f /tmp/dbwait.lock ]];then
|
|
||||||
rm -rf /config/www/framework/{cache,sessions,views,purifier}/*
|
|
||||||
fi
|
|
||||||
|
|
||||||
# check for .env and copy default if needed
|
|
||||||
if [[ ! -f "/config/www/.env" ]] || [[ ! -s "/config/www/.env" ]]; then
|
|
||||||
cp /app/www/.env.example /config/www/.env
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Check for app key
|
|
||||||
if [[ -z ${APP_KEY} ]]; then
|
|
||||||
if ! grep -qE "APP_KEY=[0-9A-Za-z:+\/=]{1,}" /config/www/.env 2> /dev/null || grep -qE "APP_KEY=SomeRandomString" /config/www/.env 2> /dev/null; then
|
|
||||||
echo "The application key is missing, halting init!"
|
|
||||||
echo "You can generate a key with: docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey"
|
|
||||||
echo "And apply it to the APP_KEY environment variable."
|
|
||||||
sleep infinity
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
## Bump php upload max filesize and post max size to 100MB by default
|
|
||||||
if ! grep -qx '^upload_max_filesize.*$' /config/php/php-local.ini; then
|
|
||||||
echo 'upload_max_filesize = 100M' >>/config/php/php-local.ini
|
|
||||||
fi
|
|
||||||
if ! grep -qx '^post_max_size.*$' /config/php/php-local.ini; then
|
|
||||||
echo 'post_max_size = 100M' >>/config/php/php-local.ini
|
|
||||||
fi
|
|
||||||
|
|
||||||
# if DB_PORT is not set
|
|
||||||
if [[ -z "${DB_PORT}" ]]; then
|
|
||||||
DB_PORT="3306"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# check for the mysql endpoint
|
|
||||||
echo "Waiting for DB to be available"
|
|
||||||
END=$((SECONDS + 30))
|
|
||||||
while [[ ${SECONDS} -lt ${END} ]] && [[ -n "${DB_HOST+x}" ]]; do
|
|
||||||
if [[ $(/usr/bin/nc -w1 "${DB_HOST}" "${DB_PORT}" | tr -d '\0') ]]; then
|
|
||||||
if [[ ! -f /tmp/dbwait.lock ]]; then
|
|
||||||
sleep 5
|
|
||||||
fi
|
|
||||||
touch /tmp/dbwait.lock
|
|
||||||
break
|
|
||||||
else
|
|
||||||
sleep 1
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# update database - will set up database if fresh, or, migrate existing
|
|
||||||
php /app/www/artisan migrate --force
|
|
||||||
|
|
||||||
# permissions
|
|
||||||
lsiown -R abc:abc \
|
|
||||||
/config
|
|
||||||
@ -1 +0,0 @@
|
|||||||
oneshot
|
|
||||||
@ -1 +0,0 @@
|
|||||||
/etc/s6-overlay/s6-rc.d/init-bookstack-config/run
|
|
||||||
@ -1 +0,0 @@
|
|||||||
longrun
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
#!/usr/bin/with-contenv bash
|
|
||||||
# shellcheck shell=bash
|
|
||||||
|
|
||||||
echo "*** Starting Async Action Queue ***"
|
|
||||||
|
|
||||||
exec /usr/bin/php /app/www/artisan queue:work --sleep=3 --tries=1 --max-time=3600
|
|
||||||
@ -1 +0,0 @@
|
|||||||
longrun
|
|
||||||
2
root/etc/s6-overlay/s6-rc.d/svc-memcached/run → root/etc/services.d/memcached/run
Executable file → Normal file
2
root/etc/s6-overlay/s6-rc.d/svc-memcached/run → root/etc/services.d/memcached/run
Executable file → Normal file
@ -1,4 +1,2 @@
|
|||||||
#!/usr/bin/with-contenv bash
|
#!/usr/bin/with-contenv bash
|
||||||
# shellcheck shell=bash
|
|
||||||
|
|
||||||
exec memcached -u abc
|
exec memcached -u abc
|
||||||
2
root/etc/services.d/php-fpm/run
Normal file
2
root/etc/services.d/php-fpm/run
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
#!/usr/bin/with-contenv bash
|
||||||
|
exec /usr/sbin/php-fpm7 -F
|
||||||
@ -1,9 +0,0 @@
|
|||||||
#!/usr/bin/with-contenv bash
|
|
||||||
# shellcheck shell=bash
|
|
||||||
|
|
||||||
if [[ -n "${QUEUE_CONNECTION}" ]]; then
|
|
||||||
touch /etc/s6-overlay/s6-rc.d/user/contents.d/svc-queue-worker
|
|
||||||
fi
|
|
||||||
|
|
||||||
exec \
|
|
||||||
/docker-mods
|
|
||||||
@ -1,11 +0,0 @@
|
|||||||
#!/usr/bin/with-contenv bash
|
|
||||||
# shellcheck shell=bash
|
|
||||||
|
|
||||||
DEFAULT_CONF="/config/nginx/site-confs/default.conf"
|
|
||||||
OLD_ROOT="root /var/www/html/public;"
|
|
||||||
NEW_ROOT="root /app/www/public;"
|
|
||||||
|
|
||||||
if [[ -f "${DEFAULT_CONF}" ]] && grep -q "${OLD_ROOT}" "${DEFAULT_CONF}" 2>/dev/null; then
|
|
||||||
echo "updating root in ${DEFAULT_CONF}"
|
|
||||||
sed -i "s|${OLD_ROOT}|${NEW_ROOT}|" "${DEFAULT_CONF}"
|
|
||||||
fi
|
|
||||||
@ -1,40 +0,0 @@
|
|||||||
<html>
|
|
||||||
<head>
|
|
||||||
<title>Upgrade Required!</title>
|
|
||||||
<style>
|
|
||||||
body{
|
|
||||||
font-family: Helvetica, Arial, sans-serif;
|
|
||||||
}
|
|
||||||
.message{
|
|
||||||
width:440px;
|
|
||||||
padding:20px 40px;
|
|
||||||
margin:0 auto;
|
|
||||||
background-color:#f9f9f9;
|
|
||||||
border:1px solid #ddd;
|
|
||||||
color: #1e3d62;
|
|
||||||
}
|
|
||||||
center{
|
|
||||||
margin:40px 0;
|
|
||||||
}
|
|
||||||
h1{
|
|
||||||
font-size: 18px;
|
|
||||||
line-height: 26px;
|
|
||||||
}
|
|
||||||
p{
|
|
||||||
font-size: 12px;
|
|
||||||
}
|
|
||||||
a{
|
|
||||||
color: rgb(207, 48, 139);
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div class="message">
|
|
||||||
<h1>Upgrade Required!</h1>
|
|
||||||
<p>The application inside this image has been moved to a new folder.</p>
|
|
||||||
<p>You will need to update your <strong>/config/nginx/nginx.conf</strong> and <strong>/config/nginx/site-confs/default.conf</strong> in order for the application to work.</p>
|
|
||||||
<p>New config samples are located at <strong>/config/nginx/nginx.conf.sample</strong> and <strong>/config/nginx/site-confs/default.conf.sample</strong></p>
|
|
||||||
<p>Please review our announcement: <a target="_blank" href="https://info.linuxserver.io/issues/2022-08-20-nginx-base/">Significant changes to nginx based images</a></p>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
Loading…
x
Reference in New Issue
Block a user