Self-host BookStack with Levelrail

Verified

A simple, self-hosted platform for organizing documentation into books, chapters, and pages.

  • AuthorBookStackAppVerified by Levelrail
  • LicenceMIT
  • Memory512 MiB
  • Archarm64
  • Services2

How to self-host BookStack

  1. Pull the images

    2 images are pulled on your server.

    Show images
    • lscr.io/linuxserver/bookstack:24.05.2
    • mariadb:11
  2. Create the app

    2 services start in a single Compose app, with 2 named volume mounts for your data, on port 80.

  3. Fill in the secrets

    3 secrets are generated and stored encrypted, 6 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

BookStack requirements

Memory
About 512 MiB
Architectures
amd64 image published, arm64 tested
Ports
80
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
MIT, permissive license
  • Verified. Verified on arm64 with image tag 24.05.2. Our CI ran this exact image version and it answered on its health path. Evidence
  • Host ports. It publishes port 80 on the host, so open them in the VPS firewall only if you want that.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then BookStack. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the BookStack docs page.

Deploy BookStack your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy BookStack from the CLI

levelrail-cli templates deploy bookstack --name my-bookstack

Deploy BookStack with the API

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/bookstack/deploy

BookStack configuration

BookStack services

ServiceImagePortsVolumes
bookstack lscr.io/linuxserver/bookstack:24.05.2 80 bookstack_data -> /config
db mariadb:11 none bookstack_db_data -> /var/lib/mysql

BookStack environment variables

VariableServiceValue
APP_URL bookstack Preset by the template
DB_DATABASE bookstack Preset by the template
DB_HOST bookstack Preset by the template
DB_PASSWORD bookstack Generated at deploy
DB_USERNAME bookstack Preset by the template
MYSQL_DATABASE db Preset by the template
MYSQL_PASSWORD db Generated at deploy
MYSQL_ROOT_PASSWORD db Generated at deploy
Show all 9 variables
  • MYSQL_USERdbPreset by the template

Ports and volumes

Ports
80
Volumes
2 named mounts: bookstack_data -> /config, bookstack_db_data -> /var/lib/mysql

BookStack FAQ

How much memory does BookStack need?

The catalog lists about 512 MiB of memory for BookStack across its 2 services.

Does BookStack run on arm64?

For BookStack, arm64 is tested; amd64 is image published.

What licence is BookStack under?

BookStack is licensed under MIT, which is permissive, with few conditions on reuse.

Does BookStack need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which database does BookStack bundle?

The template includes MySQL, running as its own service.

Which ports does BookStack use?

BookStack listens on port 80 inside the stack.

Where does BookStack keep its data?

In named volumes: bookstack_data mounted at /config and bookstack_db_data mounted at /var/lib/mysql.

Can I deploy BookStack on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id bookstack for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image lscr.io/linuxserver/bookstack:24.05.2, mariadb:11 is what you deploy there.

levelrail-cli templates deploy bookstack --name my-bookstack