ronmallorydmg/linuxserver-docker-bookstack-test repository overview

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:

• Discord⁠ - realtime support / chat with the community and the team.
• IRC⁠ - on freenode at #linuxserver.io. Our primary support channel is Discord.
• Blog⁠ - all the things you can do with our containers including How-To guides, opinions and much more!

⁠linuxserver/bookstack⁠

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⁠

⁠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 linuxserver/bookstack 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:

⁠Usage

Here are some example snippets to help you get started creating a container.

⁠docker

docker create \
  --name=bookstack \
  -e PUID=1000 \
  -e PGID=1000 \
  -e DB_HOST=<yourdbhost> \
  -e DB_USER=<yourdbuser> \
  -e DB_PASS=<yourdbpass> \
  -e DB_DATABASE=bookstackapp \
  -e APP_URL=http://your.site.here.xyz `#optional` \
  -p 6875:80 \
  -v <path to data>:/config \
  --restart unless-stopped \
  linuxserver/bookstack

⁠docker-compose

Compatible with docker-compose v2 schemas.

---
version: "2"
services:
  bookstack:
    image: linuxserver/bookstack
    container_name: bookstack
    environment:
      - PUID=1000
      - PGID=1000
      - DB_HOST=bookstack_db
      - DB_USER=bookstack
      - DB_PASS=<yourdbpass>
      - DB_DATABASE=bookstackapp
    volumes:
      - <path to data>:/config
    ports:
      - 6875:80
    restart: unless-stopped
    depends_on:
      - bookstack_db
  bookstack_db:
    image: 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:
      - <path to data>:/config
    restart: unless-stopped

⁠Parameters

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

⁠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)

⁠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 https://hub.docker.com/r/linuxserver/mariadb/⁠.

If you intend to use this application behind a subfolder reverse proxy, such as our LetsEncrypt container or Traefik you will need to make sure that the APP_URL environment variable is set, or it will not work

Documentation for BookStack can be found at https://www.bookstackapp.com/docs/⁠

⁠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, or APP_URL. The container will copy an .env file to /config/www/.env on your host system for you to edit. When you create the container, do not set any arguments for any SQL settings, or APP_URL. 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 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.

⁠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" }}' linuxserver/bookstack

⁠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 (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 Run/Create

• Update the image: docker pull linuxserver/bookstack
• Stop the running container: docker stop bookstack
• Delete the container: docker rm bookstack
• Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
• Start the new container: docker start bookstack
• You can also remove the old dangling images: docker image prune

⁠Via Docker Compose

• Update all images: docker-compose pull
  • or update a single image: docker-compose pull bookstack
• Let compose update all containers as necessary: docker-compose up -d
  • or update a single container: docker-compose up -d bookstack
• You can also remove the old dangling images: docker image prune

⁠Via Watchtower auto-updater (especially useful 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:

  docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once bookstack
  

  Copy

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.

• You can also remove the old dangling images: docker image prune

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

⁠Versions

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