GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Docker Pulls Docker Stars Jenkins Build LSIO CI

Bookstack is a free and open source Wiki designed for creating beautiful documentation. Featuring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.

Powered by SQL and including a Markdown editor for those who prefer it, BookStack is geared towards making documentation more of a pleasure than a chore.

For more information on BookStack visit their website and check it out:

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 and our announcement here.

Simply pulling should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:









Application Setup

The default username is [email protected] 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

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

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 is available to use as an alternative PDF rendering generator as described at

The path to wkhtmltopdf in this image to include in your .env file is /usr/bin/wkhtmltopdf.


To help you get started creating a container from this image you can either use docker-compose or the docker cli.

version: "2"
container_name: bookstack
- PUID=1000
- PGID=1000
- DB_HOST=bookstack_db
- DB_USER=bookstack
- DB_PASS=<yourdbpass>
- DB_DATABASE=bookstackapp
- /path/to/data:/config
- 6875:80
restart: unless-stopped
- bookstack_db
container_name: bookstack_db
- PUID=1000
- PGID=1000
- MYSQL_ROOT_PASSWORD=<yourdbpass>
- TZ=Europe/London
- MYSQL_DATABASE=bookstackapp
- MYSQL_USER=bookstack
- MYSQL_PASSWORD=<yourdbpass>
- /path/to/data:/config
restart: unless-stopped

docker run -d \
--name=bookstack \
-e PUID=1000 \
-e PGID=1000 \
-e APP_URL= \
-e DB_HOST=<yourdbhost> \
-e DB_USER=<yourdbuser> \
-e DB_PASS=<yourdbpass> \
-e DB_DATABASE=bookstackapp \
-p 6875:80 \
-v /path/to/data:/config \
--restart unless-stopped \


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.

Ports (-p)




will map the container's port 80 to port 6875 on the host

Environment Variables (-e)




for UserID - see below for explanation


for GroupID - see below for explanation


for specifying the IP:port or URL your application will be accessed on (ie. or


for specifying the database host


for specifying the database user


for specifying the database password


for specifying the database to be used

Volume Mappings (-v)




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:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

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 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.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

Docker Mods Docker Universal Mods

We publish various 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:

    • docker exec -it bookstack /bin/bash

  • To monitor the logs of the container in realtime:

    • docker logs -f bookstack

  • Container version number

    • docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack

  • Image version number

    • docker inspect -f '{{ index .Config.Labels "build_version" }}'


  • 11.07.21: - Rebase to Alpine 3.14.

  • 12.01.21: - Remove unused requirement, as of release 0.31.0.

  • 17.12.20: - Make APP_URL var required (upstream changes).

  • 17.09.20: - Rebase to alpine 3.12. Fix APP_URL setting. Bump php post max and upload max filesizes to 100MB by default.

  • 19.12.19: - Rebasing to alpine 3.11.

  • 26.07.19: - Use old version of tidyhtml pending upstream fixes.

  • 28.06.19: - Rebasing to alpine 3.10.

  • 14.06.19: - Add wkhtmltopdf to image for PDF rendering.

  • 20.04.19: - Rebase to Alpine 3.9, add MySQL init logic.

  • 22.03.19: - Switching to new Base images, shift to arm32v7 tag.

  • 20.01.19: - Added php7-curl

  • 04.11.18: - Added php7-ldap

  • 15.10.18: - Changed functionality for advanced users

  • 08.10.18: - Advanced mode, symlink changes, sed fixing, docs updated, added some composer files

  • 23.09.28: - Updates pre-release

  • 02.07.18: - Initial Release.