Bot Updating Documentation

images/docker-bookstack.md

@@ -1,6 +1,9 @@
 ---
 title: bookstack
 ---
+<!-- DO NOT EDIT THIS FILE MANUALLY  -->
+<!-- Please read the https://github.com/linuxserver/docker-bookstack/blob/master/.github/CONTRIBUTING.md -->
+
 # [linuxserver/bookstack](https://github.com/linuxserver/docker-bookstack)
 
 [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-bookstack.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-bookstack)
@@ -19,7 +22,6 @@ Powered by SQL and including a Markdown editor for those who prefer it, BookStac
 
 For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
 
-
 ## Supported Architectures
 
 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/).
@@ -34,6 +36,27 @@ The architectures supported by this image are:
 | 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://dockerhost:6875.
+
+This application is dependent on a MySQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container here https://hub.docker.com/r/linuxserver/mariadb/.
+
+
+If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the `APP_URL` environment variable is set to your external domain, or it will not work
+
+Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
+
+### Advanced Users (full control over the .env file)
+If you wish to use the extra functionality of BookStack such as email, Memcache, LDAP and so on you will need to make your own .env file with guidance from the BookStack documentation.
+  
+When you create the container, do not set any arguments for any SQL settings. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
+
+#### 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`.
 
 ## Usage
 
@@ -84,7 +107,7 @@ services:
 
 ### docker cli
 
-```
+```bash
 docker run -d \
   --name=bookstack \
   -e PUID=1000 \
@@ -100,7 +123,6 @@ docker run -d \
   ghcr.io/linuxserver/bookstack
 ```
 
-
 ## Parameters
 
 Docker 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.
@@ -111,7 +133,6 @@ Docker images are configured using parameters passed at runtime (such as those a
 | :----: | --- |
 | `80` | will map the container's port 80 to port 6875 on the host |
 
-
 ### Environment Variables (`-e`)
 
 | Env | Function |
@@ -130,15 +151,13 @@ Docker images are configured using parameters passed at runtime (such as those a
 | :----: | --- |
 | `/config` | this will store any uploaded data on the docker host |
 
-
-
 ## 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__PASSWORD=/run/secrets/mysecretpassword
 ```
 
@@ -149,7 +168,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
 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
 
 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`.
@@ -158,40 +176,17 @@ Ensure any volume directories on the host are owned by the same user you specify
 
 In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
 
-```
+```bash
   $ id username
     uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
 ```
 
-## Application Setup
-
-
-The default username is admin@admin.com with the password of **password**, access the container at http://dockerhost:6875.
-
-This application is dependent on a MySQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container here https://hub.docker.com/r/linuxserver/mariadb/.
-
-
-If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the `APP_URL` environment variable is set to your external domain, or it will not work
-
-Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
-
-### Advanced Users (full control over the .env file)
-If you wish to use the extra functionality of BookStack such as email, Memcache, LDAP and so on you will need to make your own .env file with guidance from the BookStack documentation.
-  
-When you create the container, do not set any arguments for any SQL settings. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
-
-#### 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`.
-
-
 ## Docker Mods
+
 [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=bookstack&query=%24.mods%5B%27bookstack%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=bookstack "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
 
 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
 
 * Shell access whilst the container is running: