linuxserver / docker-bookstack

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

Added file/folder path mapping to readme #168

Closed ssddanbrown closed 1 year ago

ssddanbrown commented 1 year ago

linuxserver.io



Description:

This adds details of how BookStack files and folders within the container /config volume relate to those within a default BookStack installation.

Benefits of this PR and context:

Related to #167.

The default file/folder names used within the mounted /config folder only match those within a BookStack installation by name, and they can be tricky to understand without understanding how these are linked within the container. Users can often need to know/use these files and directories when following BookStack documentation, for things like migrations from non-docker installs, or when switching between image storage options.

How Has This Been Tested?

I have read-through my changes a couple of times, and ran them through the jenkins-builder process then checked the README.md file output to ensure it was valid.

Source / References:

LinuxServer-CI commented 1 year ago

I am a bot, here are the test results for this PR: https://ci-tests.linuxserver.io/lspipepr/bookstack/v23.02.3-pkg-ec4bad7b-pr-168/index.html https://ci-tests.linuxserver.io/lspipepr/bookstack/v23.02.3-pkg-ec4bad7b-pr-168/shellcheck-result.xml