Bookstack (container)

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: https://www.bookstackapp.com

Image details

Pulls: 74.7M

Architecture: amd64, arm64

Image size: 109 MB

Latest: 26.05.3

User: linuxserver

Created: Aug 20, 2018

Updated: 4 days ago

Status: active

Configuration

Type

Container

Platform

linux

Image

linuxserver/bookstack:latest

Ports

6875:80/tcp

Volumes

/config : /srv/lsio/bookstack/config

Env vars

PUID=1000PGID=1000TZ=Etc/UTCAPP_URL=APP_KEY=DB_HOST=DB_PORT=3306DB_USERNAME=DB_PASSWORD=DB_DATABASE=QUEUE_CONNECTION=

Restart

unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/bookstack/config

Standalone Install

Select an install method, to see config/commands for deploying Bookstack (container)

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

Ensure both Docker and Portainer are installed, and up-to-date
Log into your Portainer web UI
Under Settings → App Templates, paste the below URL
Head to Home → App Templates, and the list of apps will show up
Select Bookstack (container), fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

Show Me

More install options in our documentation.

The LinuxServer.io team brings you another container release featuring:

regular and timely application updates
easy user mappings (PGID, PUID)
custom base image with s6 overlay
weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
regular security updates

Find us at:

Blog - all the things you can do with our containers including How-To guides, opinions and much more!
Discord - realtime support / chat with the community and the team.
Discourse - post on our community forum.
GitHub - view the source for all of our repositories.
Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/bookstack

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: https://www.bookstackapp.com

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/bookstack:latest 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:

Architecture	Available	Tag
x86-64	✅	amd64-\
arm64	✅	arm64v8-\

Application Setup

The default username is admin@admin.com with the password of password, access the container at http://:6875.
This application is dependent on a MariaDB database, be it one you already have or a new one. If you do not already have one, we provide an image here https://github.com/linuxserver/docker-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/.

BookStack File & Directory Paths

This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the /config folder so that they are persistent & accessible when the /config container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation.
Below is a mapping of container /config paths to those relative within a BookStack install directory:

/config container path => BookStack relative path
/config/www/.env => .env
/config/log/bookstack/laravel.log => storage/logs/laravel.log
/config/backups/ => storage/backups/
/config/www/files/ => storage/uploads/files/
/config/www/images/ => storage/uploads/images/
/config/www/themes/ => themes/
/config/www/uploads/ => public/uploads/

Changing APPURL

If you change the APPURL after initial install, you should run the following line from your host terminal to update the database URL entries:
docker exec -it bookstack php /app/www/artisan bookstack:update-url ${OLD_URL} ${NEW_URL}
Advanced Users (full control over the .env file)
If you wish to use the extra functionality of BookStack such as email, LDAP and so on you will need to set additional environment variables or make your own .env file with guidance from the BookStack documentation.
The container will copy an exemplary .env file to /config/www/.env on your host system for you to use.
Read-Only Operation
This image can be run with a read-only container filesystem. For details please read the docs.

Caveats

/tmp must be mounted to tmpfs

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)

---
services:
  bookstack:
    image: lscr.io/linuxserver/bookstack:latest
    container_name: bookstack
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - APP_URL=
      - APP_KEY=
      - DB_HOST=
      - DB_PORT=3306
      - DB_USERNAME=
      - DB_PASSWORD=
      - DB_DATABASE=
      - QUEUE_CONNECTION= #optional
    volumes:
      - /path/to/bookstack/config:/config
    ports:
      - 6875:80
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=bookstack \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e APP_URL= \
  -e APP_KEY= \
  -e DB_HOST= \
  -e DB_PORT=3306 \
  -e DB_USERNAME= \
  -e DB_PASSWORD= \
  -e DB_DATABASE= \
  -e QUEUE_CONNECTION= `#optional` \
  -p 6875:80 \
  -v /path/to/bookstack/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/bookstack:latest

Parameters

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

Parameter	Function
`-p 6875:80`	http/s web interface.
`-e PUID=1000`	for UserID - see below for explanation
`-e PGID=1000`	for GroupID - see below for explanation
`-e TZ=Etc/UTC`	specify a timezone to use, see this list.
`-e APPURL=`	The protocol, IP/URL, and port that your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com`
`-e APPKEY=`	Session encryption key. You will need to generate this with `docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey`
`-e DBHOST=`	The database instance hostname
`-e DBPORT=3306`	Database port
`-e DBUSERNAME=`	Database user
`-e DBPASSWORD=`	Database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.)
`-e DBDATABASE=`	Database name
`-e QUEUECONNECTION=`	Set to `database` to enable async actions like sending email or triggering webhooks. See documentation.
`-v /config`	Persistent config files
`--read-only=true`	Run container with a read-only filesystem. Please read the docs.

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__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker 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:

```bash
docker exec -it bookstack /bin/bash
```

To monitor the logs of the container in realtime:

```bash
docker logs -f bookstack
```

Container version number:

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

Image version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/bookstack:latest
```

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:

Via Docker Compose

Update images:

* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull bookstack
    ```

Update containers:

* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d bookstack
    ```

You can also remove the old dangling images:

```bash
docker image prune
```

Via Docker Run

Update the image:

```bash
docker pull lscr.io/linuxserver/bookstack:latest
```

Stop the running container:

```bash
docker stop bookstack
```

Delete the container:

```bash
docker rm bookstack
```

Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:

```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-bookstack.git
cd docker-bookstack
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/bookstack:latest .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions
05.08.26: - Run the async queue worker as the PUID/PGID-managed abc user.
05.07.26: - Rebase to Alpine 3.24.
29.04.26: - Switch to pulling releases from Codeberg.
28.12.25: - Rebase to Alpine 3.23.
05.07.25: - Rebase to Alpine 3.22.
04.01.25: - Add php-opcache.
17.12.24: - Rebase to Alpine 3.21.
11.10.24: - Default to environment config over .env file config.
06.09.24: - Add php-exif for reading image EXIF data.
27.05.24: - Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings.
25.01.24: - Existing users should update: site-confs/default.conf - Cleanup default site conf.
23.12.23: - Rebase to Alpine 3.19 with php 8.3.
31.10.23: - Further sanitize sed replace.
07.06.23: - Add mariadb-client for bookstack-system-cli support.
25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
13.04.23: - Move ssl.conf include to default.conf.
01.03.23: - Add php iconv.
19.01.23: - Rebase to alpine 3.17 with php8.1.
16.01.23: - Wrap .env values in quotes.
05.01.23: - Fix db password setting (sed escape &).
21.12.22: - Update db info in .env file when env vars are updated.
10.10.22: - Remove password escape logic which caused problems for a small subset of users.
20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
14.03.22: - Add symlinks for theme support.
11.07.21: - Rebase to Alpine 3.14.
12.01.21: - Remove unused requirement, as of release 0.31.0.
17.12.20: - Make APPURL var required (upstream changes).
17.09.20: - Rebase to alpine 3.12. Fix APPURL 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.

Serve Bookstack (container) on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxy Domain App port Upstream

Proxying bookstack-container.example.com to http://Bookstack:80

Add this to your Caddyfile

bookstack-container.example.com {
	reverse_proxy http://Bookstack:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

In Portainer, go to Containers, click the container, then Logs. Or run docker logs Bookstack
Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:6875 failed: port is already allocated", something else on your server is using that port.

Find what's using it: sudo ss -tlnp | grep :6875
Stop the other service, or pick a different host port. In 6875:80 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

Use your server's real IP: http://your-server-ip:6875. The 0.0.0.0 link Portainer shows isn't a real address.
Give it a minute after first deploy, Bookstack can take a while to initialise.
Make sure your firewall allows the port, e.g. sudo ufw allow 6875

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/bookstack/config
Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/bookstack:latest

"manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
"toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
"no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

This image supports: amd64, arm64
Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

Check the logs right after a restart, the last few lines before it died are the useful ones.
Get the exit code with docker inspect Bookstack --format '{{.State.ExitCode}}'
Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

APP_URL, APP_KEY, DB_HOST, DB_USERNAME, DB_PASSWORD, DB_DATABASE, QUEUE_CONNECTION have no default value, and Bookstack may crash or misbehave if left empty.

Fill them in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Bug within the app: Open an issue within Bookstack's repo
Template not working: Open an issue on technorabilia/portainer-templates
This website not working: Open an issue on lissy93/portainer-templates

A single container

Bookstack (container) runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Bookstack (container) needs bundled into one download. This template pulls linuxserver/bookstack:latest, which Docker fetches once (about 109 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Bookstack (container)'s comes from Docker Hub, published by linuxserver.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 26.05.3. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 6875:80 means it's reachable on port 6875 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:6875 in a browser. It opens:

6875:80, likely the web interface

Volumes

A volume is where Bookstack (container) keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

/config from /srv/lsio/bookstack/config on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Bookstack (container) takes 11 of them, and 7 need a value before it'll start properly:

PUID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the UID to use here.
PGID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the GID to use here.
TZ, defaults to Etc/UTC. Specify a timezone to use, see this list.
APP_URL, needs a value. The protocol, IP/URL, and port that your application will be accessed on (ie. http://192.168.1.1:6875 or https://bookstack.mydomain.com
APP_KEY, needs a value. Session encryption key. You will need to generate this with docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey
DB_HOST, needs a value. The database instance hostname
DB_PORT, defaults to 3306. Database port
DB_USERNAME, needs a value. Database user
DB_PASSWORD, needs a value. Database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.)
DB_DATABASE, needs a value. Database name
QUEUE_CONNECTION, needs a value. Set to database to enable async actions like sending email or triggering webhooks. See documentation. [OPTIONAL]

Restart policy

The restart policy here is unless-stopped, so Docker restarts Bookstack (container) after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Bookstack (container) sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container Bookstack. That's what you'll spot in the containers list and use in commands like docker logs Bookstack.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Bookstack (container) up. Add the template list to Portainer once, then deploying Bookstack (container) is a click rather than a wall of config.

Bookstack (container)

Image details

Configuration

Notes

Standalone Install

Install on Portainer

Template Import URL

Container Documentation

linuxserver/bookstack

Supported Architectures

Application Setup

BookStack File & Directory Paths

Changing APPURL

Advanced Users (full control over the .env file)

Read-Only Operation

Caveats

Usage

docker-compose (recommended, click here for more info)

docker cli (click here for more info)

Parameters

Environment variables from files (Docker secrets)

Umask for running applications

User / Group Identifiers

Docker Mods

Support Info

Updating Info

Via Docker Compose

Via Docker Run

Image Update Notifications - Diun (Docker Image Update Notifier)

Building locally

Versions

Recent versions

Proxy configurator

Troubleshooting

Check the logs first

Port already in use

Running but the page won't load

Permission denied on volumes

Image won't pull

"exec format error"

Container keeps restarting

Required settings are blank

Raise an issue

Config glossary

A single container

The app image

Where the image comes from

Version tags

Which machines it runs on

Ports

Volumes

Environment variables

Restart policy

Users and permissions

Networking

Container name

Platform

Portainer app templates

Similar apps