Repository files navigation

TheLinuxServer.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.
• 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 asx86-64,arm64 andarmhf. We utilise the docker manifest for multi-platform awareness. More information is available from dockerhere and our announcementhere.

Simply pullinglinuxserver/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:

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

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

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

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 port80 from inside the container to be accessible from the host's IP on port8080 outside the container.

You can set any environment variable from a file by using a special prependFILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

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

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 userPUID and groupPGID.

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 instancePUID=1000 andPGID=1000, to find yours useid user as below:

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

The default username isadmin@admin.com with the password ofpassword, access the container athttp://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 herehttps://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 theAPP_URL environment variable is set, or it will not work

Documentation for BookStack can be found athttps://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, or APP_URL. 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 athttps://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 variousDocker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.

• 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

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 theApplication Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

• 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

• 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

• 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

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

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.gitcd docker-bookstackdocker build \  --no-cache \  --pull \  -t linuxserver/bookstack:latest .

The ARM variants can be built on x86_64 hardware usingmultiarch/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.

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