A Docker container for the BookStack documentation wiki
The LinuxServer.io team brings you another container release featuring:
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. * Fleet - an online web interface which displays all of our maintained images. * GitHub - view the source for all of our repositories. * Open Collective - please consider helping us by either donating or contributing to our budget
Bookstack is a free and open source Wiki designed for creating beautiful documentation. Feautring 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
Our images support multiple architectures such as
x86-64,
arm64and
armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling
ghcr.io/linuxserver/bookstackshould 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 | Tag | | :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest |
Here are some example snippets to help you get started creating a container.
Compatible with docker-compose v2 schemas.
--- version: "2" services: bookstack: image: ghcr.io/linuxserver/bookstack container_name: bookstack environment: - PUID=1000 - PGID=1000 - APP_URL= - DB_HOST=bookstack_db - DB_USER=bookstack - DB_PASS= - DB_DATABASE=bookstackapp volumes: - /path/to/data:/config ports: - 6875:80 restart: unless-stopped depends_on: - bookstack_db bookstack_db: image: ghcr.io/linuxserver/mariadb container_name: bookstack_db environment: - PUID=1000 - PGID=1000 - MYSQL_ROOT_PASSWORD= - TZ=Europe/London - MYSQL_DATABASE=bookstackapp - MYSQL_USER=bookstack - MYSQL_PASSWORD= volumes: - /path/to/data:/config restart: unless-stopped
docker run -d \ --name=bookstack \ -e PUID=1000 \ -e PGID=1000 \ -e APP_URL= \ -e DB_HOST= \ -e DB_USER= \ -e DB_PASS= \ -e DB_DATABASE=bookstackapp \ -p 6875:80 \ -v /path/to/data:/config \ --restart unless-stopped \ ghcr.io/linuxserver/bookstack
Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate
:respectively. For example,
-p 8080:80would expose port
80from inside the container to be accessible from the host's IP on port
8080outside the container.
| Parameter | Function | | :----: | --- | |
-p 80| will map the container's port 80 to port 6875 on the host | |
-e PUID=1000| for UserID - see below for explanation | |
-e PGID=1000| for GroupID - see below for explanation | |
-e APP_URL=| for specifying the IP:port or URL your application will be accessed on (ie.
http://192.168.1.1:6875or
https://bookstack.mydomain.com| |
-e DB_HOST=| for specifying the database host | |
-e DB_USER=| for specifying the database user | |
-e DB_PASS=| for specifying the database password | |
-e DB_DATABASE=bookstackapp| for specifying the database to be used | |
-v /config| this will store any uploaded data on the docker host |
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
PASSWORDbased on the contents of the
/run/secrets/mysecretpasswordfile.
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=022setting. 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.
When using volumes (
-vflags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user
PUIDand 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=1000and
PGID=1000, to find yours use
id useras below:
$ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
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 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_URLenvironment variable is set to your external domain, or it will not work
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/
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.
wkhtmltopdf 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.
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.
docker exec -it bookstack /bin/bash
docker logs -f bookstack
docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack
docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/bookstack
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:
docker-compose pull
docker-compose pull bookstack
docker-compose up -d
docker-compose up -d bookstack
docker image prune
docker pull ghcr.io/linuxserver/bookstack
docker stop bookstack
docker rm bookstack
/configfolder and settings will be preserved)
docker image prune
docker run --rm \ -v /var/run/docker.sock:/var/run/docker.sock \ containrrr/watchtower \ --run-once bookstack
docker image prune
Note: 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.
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 ghcr.io/linuxserver/bookstack:latest .
The ARM variants can be built on x86_64 hardware using
multiarch/qemu-user-static
docker run --rm --privileged multiarch/qemu-user-static:register --reset
Once registered you can define the dockerfile to use with
-f Dockerfile.aarch64.