Portainer Templates logo

Portainer Templates

Bookstack (stack) Bookstack (stack)

Wiki

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.

Configuration

Type
Compose
Platform
linux
Env vars
PUID=1000PGID=100TZ=''DATABASE_PASSWORD=''MYSQL_ROOT_PASSWORD=''PORT=''
Source
Repo

Template by Qballjos·Source

Notes

Default login is [email protected] with a password of password. The database created is called bookstackapp and the database user is called bookstack

Services

bookstack

Configuration

Image
linuxserver/bookstack
Ports
${PORT}:80
Volumes
/config : /portainer/Files/AppData/Bookstack/Data
Env vars
PUID=${PUID}PGID=${PGID}DB_HOST=bookstack_dbDB_USER=bookstackDB_PASS=${DATABASE_PASSWORD}DB_DATABASE=bookstackapp
Restart
unless-stopped

Image details

Pulls: 74.7M
User: linuxserver
Created: Aug 20, 2018
Updated: 4 days ago
Status: active

bookstack_db

Configuration

Image
linuxserver/mariadb
Volumes
/config : /portainer/Files/AppData/Bookstack/DB
Env vars
PUID=${PUID}PGID=${PGID}MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}TZ=${TZ}MYSQL_DATABASE=bookstackappMYSQL_USER=bookstackMYSQL_PASSWORD=${DATABASE_PASSWORD}
Restart
unless-stopped

Image details

Pulls: 417.9M
User: linuxserver
Created: Oct 13, 2015
Updated: 11 days ago
Status: active

Standalone Install

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

Installation method

Install on Portainer

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

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

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

---
version: "2"
services:
  bookstack:
    image: linuxserver/bookstack
    container_name: bookstack
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - DB_HOST=bookstack_db
      - DB_USER=bookstack
      - DB_PASS=${DATABASE_PASSWORD}
      - DB_DATABASE=bookstackapp
    volumes:
      - /portainer/Files/AppData/Bookstack/Data:/config
    ports:
      - ${PORT}:80
    restart: unless-stopped
    depends_on:
      - bookstack_db
  bookstack_db:
    image: linuxserver/mariadb
    container_name: bookstack_db
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
      - TZ=${TZ}
      - MYSQL_DATABASE=bookstackapp
      - MYSQL_USER=bookstack
      - MYSQL_PASSWORD=${DATABASE_PASSWORD}
    volumes:
      - /portainer/Files/AppData/Bookstack/DB:/config
    restart: unless-stopped

Or deploy it directly from the source:

git clone https://github.com/Qballjos/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/bookstack.yml up -d

More install options in our documentation.

Container Documentation

bookstack Documentation

bookstack_db Documentation

A Mariadb container, brought to you by LinuxServer.io.

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 <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

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 ${PUID}:${PGID} /portainer/Files/AppData/Bookstack/Data (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults ${PUID}:${PGID}) to match your own user, found with id $USER

Image won't pull

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

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

  • 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 <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

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

A Compose stack

Bookstack (stack) is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • bookstack runs linuxserver/bookstack, starts after bookstack_db
  • bookstack_db runs linuxserver/mariadb

Volumes

A volume is where Bookstack (stack) 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 /portainer/Files/AppData/Bookstack/Data on the host
  • /config from /portainer/Files/AppData/Bookstack/DB on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Bookstack (stack) takes 11 of them, all with defaults you can leave alone or tweak:

  • PUID, pulled from your own environment
  • PGID, pulled from your own environment
  • DB_HOST, defaults to bookstack_db
  • DB_USER, defaults to bookstack
  • DB_PASS, pulled from your own environment
  • DB_DATABASE, defaults to bookstackapp
  • MYSQL_ROOT_PASSWORD, pulled from your own environment
  • TZ, pulled from your own environment
  • MYSQL_DATABASE, defaults to bookstackapp
  • MYSQL_USER, defaults to bookstack
  • MYSQL_PASSWORD, pulled from your own environment

Restart policy

The restart policy here is unless-stopped, so Docker restarts Bookstack (stack) 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

Portainer puts these services on one shared private network, so they can find each other by name (like bookstack) while only the ports above are open to you.

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 (stack) up. Add the template list to Portainer once, then deploying Bookstack (stack) is a click rather than a wall of config.