linuxserver / docker-bookstack

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

Change README to add the different mappings for images #167

Closed H-Toine closed 1 year ago

H-Toine commented 1 year ago

Is this a new feature request?

Wanted change

Add the different mapping for the image locations to the documentation.

Reason for change

As experienced from an issue on the official bookstack repo , the mapping is different from the docker image to the official bookstack repo.

This conflicts with the official bookstack documentation. When changing your image storage_type from local (publicly available) to local_secure (only logged in users), the documentation tells you to move the images to a different location. The different locations of the folders in the docker image makes this documentation invalid.

As such, I'd propose to add the mapping to the README (or wherever you see fit).

Proposed code change

  #### Different paths for secure images
  This docker image exposes the internal BookStack folders under different paths. Below is the current mapping:

  Location within mounted /config folder => Normal BookStack filesystem location
  - www/files => storage/uploads/files
  - www/images => storage/uploads/images
  - www/themes => themes
  - uploads => public/uploads
github-actions[bot] commented 1 year ago

Thanks for opening your first issue here! Be sure to follow the relevant issue templates, or risk having this issue marked as invalid.

ssddanbrown commented 1 year ago

I've opened a PR for this in #168. In my PR I've made the wording a bit more generic than requested/suggested above since these paths can be useful to know in a range of scenarios, not just those in a "storage_type"/"secure-images" context.

ssddanbrown commented 1 year ago

Thank you very much @thespad for the review and merge!