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
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:
The default username is email@example.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/.
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
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.
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)¶
--- version: "2" services: bookstack: image: lscr.io/linuxserver/bookstack container_name: bookstack environment: - PUID=1000 - PGID=1000 - APP_URL=https://bookstack.example.com - DB_HOST=bookstack_db - DB_PORT=3306 - DB_USER=bookstack - DB_PASS=<yourdbpass> - DB_DATABASE=bookstackapp volumes: - ./bookstack_app_data:/config ports: - 6875:80 restart: unless-stopped depends_on: - bookstack_db bookstack_db: image: lscr.io/linuxserver/mariadb container_name: bookstack_db environment: - PUID=1000 - PGID=1000 - MYSQL_ROOT_PASSWORD=<yourdbpass> - TZ=Europe/London - MYSQL_DATABASE=bookstackapp - MYSQL_USER=bookstack - MYSQL_PASSWORD=<yourdbpass> volumes: - ./bookstack_db_data:/config 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=yourbaseurl \ -e DB_HOST=yourdbhost \ -e DB_PORT=yourdbport \ -e DB_USER=yourdbuser \ -e DB_PASS=yourdbpass \ -e DB_DATABASE=bookstackapp \ -e QUEUE_CONNECTION= `#optional` \ -p 6875:80 \ -v /path/to/data:/config \ --restart unless-stopped \ lscr.io/linuxserver/bookstack:latest
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.
| ||will map the container's port 80 to port 6875 on the host|
Environment Variables (
| ||for UserID - see below for explanation|
| ||for GroupID - see below for explanation|
| ||specify a timezone to use, see this list.|
| ||for specifying the IP:port or URL your application will be accessed on (ie. |
| ||for specifying the database host|
| ||for specifying the database port if not default 3306|
| ||for specifying the database user|
| ||for specifying the database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.)|
| ||for specifying the database to be used|
| ||Set to |
Volume Mappings (
| ||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
As an example:
Will set the environment variable
MYVAR based on the contents of the
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
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
PGID=1000, to find yours use
id your_user as below:
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.
Shell access whilst the container is running:
To monitor the logs of the container in realtime:
Container version number:
Image version number:
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), 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¶
You can also remove the old dangling images:
Via Docker Run¶
Update the image:
Stop the running container:
Delete the container:
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your
/configfolder and settings will be preserved)
You can also remove the old dangling images:
Via Watchtower auto-updater (only use if you don't remember the original parameters)¶
Pull the latest image at its tag and replace it with the same env variables in one run:
You can also remove the old dangling images:
docker image prune
We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.
Image Update Notifications - Diun (Docker Image Update Notifier)¶
We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
If you want to make local modifications to these images for development purposes or just to customize the logic:
The ARM variants can be built on x86_64 hardware using
Once registered you can define the dockerfile to use with
- 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
.envvalues 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 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.
Created: January 27, 2019