Skip to main content

Preparation

There are some things we need to do in preparation to install this service.

Volumes

Persistent Data

This is where the service will store its own application data and ensures we can quickly update the service image.

Ensure your user has permissions to access the folder.

Environment

TZ

This is the current time zone formatted using the tz database.

For example: America/Vancouver

PUID

This is the numeric ID of the user account on Debian.  If you are unsure, open a terminal and run:

id -u
PGID

This is the numeric ID of the user account's group on Debian.  If you are unsure, open a terminal and run:

id -g
DB_USER

This is the username to be used for logging into the database.

For example: bookstack_admin

APP_URL

This is the URL you will be accessing the service through.  This can be the local address or the domain name.

ALLOWED_IFRAME_SOURCES

This configures which websites can be embedded with your BookStack.

Recommended: "https://*.draw.io https://*.youtube.com https://*.youtube-nocookie.com https://*.vimeo.com"


Passwords

Keep these securely stored in a password manager, such as VaultWarden.

DB_PASS

This is the password that will be used for root access to the database.

It is important to use secure, randomly generated password.

You can use a random alphanumeric string from a password manager, or open the terminal and run the command:

tr -dc 'A-Za-z0-9!"#$%&'\''()*+,-./:;<=>?@[\]^_`{|}~' </dev/urandom | head -c 32; echo

This pulls a random string from the 'urandom' device, removes unwanted characters and trim it to an appropriate length.