</code></pre></div><h3id=docker-cli-click-here-for-more-info>docker cli (<ahref=https://docs.docker.com/engine/reference/commandline/cli/>click here for more info</a>)</h3><divclass=highlight><pre><span></span><code>docker<spanclass=w></span>run<spanclass=w></span>-d<spanclass=w></span><spanclass=se>\</span>
</code></pre></div><h2id=parameters>Parameters</h2><p>Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <code><external>:<internal></code> respectively. For example, <code>-p 8080:80</code> would expose port <code>80</code> from inside the container to be accessible from the host's IP on port <code>8080</code> outside the container.</p><h3id=ports-p>Ports (<code>-p</code>)</h3><table><thead><tr><thstyle="text-align: center;">Parameter</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>80</code></td><td>will map the container's port 80 to port 6875 on the host</td></tr></tbody></table><h3id=environment-variables-e>Environment Variables (<code>-e</code>)</h3><table><thead><tr><thstyle="text-align: center;">Env</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>PUID=1000</code></td><td>for UserID - see below for explanation</td></tr><tr><tdstyle="text-align: center;"><code>PGID=1000</code></td><td>for GroupID - see below for explanation</td></tr><tr><tdstyle="text-align: center;"><code>TZ=Etc/UTC</code></td><td>specify a timezone to use, see this <ahref=https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List>list</a>.</td></tr><tr><tdstyle="text-align: center;"><code>APP_URL=<yourbaseurl></code></td><td>for specifying the IP:port or URL your application will be accessed on (ie. <code>http://192.168.1.1:6875</code> or <code>https://bookstack.mydomain.com</code></td></tr><tr><tdstyle="text-align: center;"><code>DB_HOST=<yourdbhost></code></td><td>for specifying the database host</td></tr><tr><tdstyle="text-align: center;"><code>DB_PORT=<yourdbport></code></td><td>for specifying the database port if not default 3306</td></tr><tr><tdstyle="text-align: center;"><code>DB_USER=<yourdbuser></code></td><td>for specifying the database user</td></tr><tr><tdstyle="text-align: center;"><code>DB_PASS=<yourdbpass></code></td><td>for specifying the database password (non-alphanumeric passwords must be properly escaped.)</td></tr><tr><tdstyle="text-align: center;"><code>DB_DATABASE=bookstackapp</code></td><td>for specifying the database to be used</td></tr></tbody></table><h3id=volume-mappings-v>Volume Mappings (<code>-v</code>)</h3><table><thead><tr><thstyle="text-align: center;">Volume</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>/config</code></td><td>this will store any uploaded data on the docker host</td></tr></tbody></table><h4id=miscellaneous-options>Miscellaneous Options</h4><table><thead><tr><thstyle="text-align: center;">Parameter</th><th>Function</th></tr></thead><tbody><tr><td></td><td></td></tr></tbody></table><h2id=environment-variables-from-files-docker-secrets>Environment variables from files (Docker secrets)</h2><p>You can set any environment variable from a file by using a special prepend <code>FILE__</code>.</p><p>As an example:</p><divclass=highlight><pre><span></span><code>-e<spanclass=w></span><spanclass=nv>FILE__PASSWORD</span><spanclass=o>=</span>/run/secrets/mysecretpassword
</code></pre></div><p>Will set the environment variable <code>PASSWORD</code> based on the contents of the <code>/run/secrets/mysecretpassword</code> file.</p><h2id=umask-for-running-applications>Umask for running applications</h2><p>For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional <code>-e UMASK=022</code> setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up <ahref=https://en.wikipedia.org/wiki/Umask>here</a> before asking for support.</p><h2id=user-group-identifiers>User / Group Identifiers</h2><p>When using volumes (<code>-v</code> flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user <code>PUID</code> and group <code>PGID</code>.</p><p>Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.</p><p>In this instance <code>PUID=1000</code> and <code>PGID=1000</code>, to find yours use <code>id user</code> as below:</p><divclass=highlight><pre><span></span><code><spanclass=w></span>$<spanclass=w></span>id<spanclass=w></span>username
</code></pre></div><h2id=docker-mods>Docker Mods</h2><p><ahref="https://mods.linuxserver.io/?mod=bookstack"title="view available mods for this container."><imgalt="Docker Mods"src="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"></a><ahref="https://mods.linuxserver.io/?mod=universal"title="view available universal mods."><imgalt="Docker Universal Mods"src="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"></a></p><p>We publish various <ahref=https://github.com/linuxserver/docker-mods>Docker Mods</a> 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.</p><h2id=support-info>Support Info</h2><ul><li>Shell access whilst the container is running:</li><li><code>docker exec -it bookstack /bin/bash</code></li><li>To monitor the logs of the container in realtime:</li><li><code>docker logs -f bookstack</code></li><li>Container version number</li><li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack</code></li><li>Image version number</li><li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/bookstack:latest</code></li></ul><h2id=versions>Versions</h2><ul><li><strong>07.06.23:</strong> - Add mariadb-client for bookstack-system-cli support.</li><li><strong>25.05.23:</strong> - Rebase to Alpine 3.18, deprecate armhf.</li><li><strong>13.04.23:</strong> - Move ssl.conf include to default.conf.</li><li><strong>01.03.23:</strong> - Add php iconv.</li><li><strong>19.01.23:</strong> - Rebase to alpine 3.17 with php8.1.</li><li><strong>16.01.23:</strong> - Wrap <code>.env</code> values in quotes.</li><li><strong>05.01.23:</strong> - Fix db password setting (sed escape <code>&</code>).</li><li><strong>21.12.22:</strong> - Update db info in .env file when env vars are updated.</li><li><strong>10.10.22:</strong> - Remove password escape logic which caused problems for a small subset of users.</li><li><strong>20.08.22:</strong> - Rebasing to alpine 3.15 with php8. Restructure nginx configs (<ahref=https://info.linuxserver.io/issues/2022-08-20-nginx-base>see changes announcement</a>).</li><li><strong>14.03.22:</strong> - Add symlinks for theme support.</li><li><strong>11.07.21:</strong> - Rebase to Alpine 3.14.</li><li><strong>12.01.21:</strong> - Remove unused requirement, as of release 0.31.0.</li><li><strong>17.12.20:</strong> - Make APP_URL var required (upstream changes).</li><li><strong>17.09.20:</strong> - Rebase to alpine 3.12. Fix APP_URL setting. Bump php post max and upload max filesizes to 100MB by default.</li><li><strong>19.12.19:</strong> - Rebasing to alpine 3.11.</li><li><strong>26.07.19:</strong> - Use old version of tidyhtml pending upstream fixes.</li><li><strong>28.06.19:</strong> - Rebasing to alpine 3.10.</li><li><strong>14.06.19:</strong> - Add wkhtmltopdf to image for PDF rendering.</li><li><strong>20.04.19:</strong> - Rebase to Alpine 3.9, add MySQL init logic.</li><li><strong>22.03.19:</strong> - Switching to new Base images, shift to arm32v7 tag.</li><li><strong>20.01.19:</strong> - Added php7-curl</li><li><strong>04.11.18:</strong> - Added php7-ldap</li><li><strong>15.10.18:</strong> - Changed functionality for advanced users</li><li><strong>08.10.18:</strong> - Advanced mode, symlink changes, sed fixing, docs updated, added some composer files</li><li><strong>23.09.28:</strong> - Updates pre-release</li><li><strong>02.07.18:</strong> - Initial Release.</li></ul></article></div></div
