Self-host BookStack on a VPS

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

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

Specification

Status
Verified on arm64 with image tag 24.05.2
Category
Productivity
Services
bookstack, db
Ports
80
Volumes
2
Memory
about 512 MiB
arm64
tested
amd64
image published
Settings to fill in
none

About BookStack

A simple, self-hosted platform for organizing documentation into books, chapters, and pages. Runs 2 containers (bookstack, db), with bookstack listening on port 80; data is kept in named volumes.

What it deploys

BookStack runs as 2 services in a single Compose app, listening on port 80, with 2 named volume mounts.

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

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Verified. Verified on arm64 with image tag 24.05.2. Verified means our CI ran this exact image version and it answered on its health path. Evidence
  • Host ports. It publishes port 80 directly on the host, so open them in the VPS firewall only if you want that.

Settings and environment

You do not have to fill in anything. 3 secrets are generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
bookstackAPP_URLPreset by the template
bookstackDB_DATABASEPreset by the template
bookstackDB_HOSTPreset by the template
bookstackDB_PASSWORDGenerated at deploy
bookstackDB_USERNAMEPreset by the template
dbMYSQL_DATABASEPreset by the template
dbMYSQL_PASSWORDGenerated at deploy
dbMYSQL_ROOT_PASSWORDGenerated at deploy
dbMYSQL_USERPreset by the template

Install BookStack on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get bookstack
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

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

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then BookStack.

More in Productivity

All Productivity templates