linuxserver / docker-bookstack

A Docker container for the BookStack documentation wiki
GNU General Public License v3.0
725 stars 105 forks source link

Update password restriction matching to db image manual #182

Closed jasonyang-ee closed 11 months ago

jasonyang-ee commented 11 months ago

per linuxserver/mariadb/, the required DATABASE_PASSWORD must > 4

linuxserver.io



Description:

The user manual on this repo did not sync with it's dependency https://hub.docker.com/r/linuxserver/mariadb/.

Per mariadb image, the required DATABASE_PASSWORD must greater than 4 characters.

Benefits of this PR and context:

New user who sets password less than 4 char will cause error similar to database connection issue where previous issues are all arguing DB_PASS or DB_PASSWORD which is not the solution here.

In short, it is extremely difficult to troubleshoot this error. Eventually, I decided to RTFM for one layer up which discovered the solution. This update to README should help preventing future user to pull their hair out.

** PR rule says don't PR for README typo. But this is manual content change. :)

How Has This Been Tested?

Test: setting longer password worked and short password does not. Hardware: Raspberry PI 4B. OS: Raspberry PI OS lite, arm64/v8

Source / References:

https://github.com/linuxserver/docker-mariadb#parameters

jasonyang-ee commented 11 months ago

hmm, yeah, I didn't read the guide. I will do it on the readme-vars.yml.

LinuxServer-CI commented 11 months ago
I am a bot, here are the test results for this PR: https://ci-tests.linuxserver.io/lspipepr/bookstack/v23.06.2-pkg-f1616480-dev-b270eaf8a27a2f3b96710498c1b005e97de577b0-pr-182/index.html https://ci-tests.linuxserver.io/lspipepr/bookstack/v23.06.2-pkg-f1616480-dev-b270eaf8a27a2f3b96710498c1b005e97de577b0-pr-182/shellcheck-result.xml Tag Passed
amd64-v23.06.2-pkg-f1616480-dev-b270eaf8a27a2f3b96710498c1b005e97de577b0-pr-182
arm64v8-v23.06.2-pkg-f1616480-dev-b270eaf8a27a2f3b96710498c1b005e97de577b0-pr-182