# BookStack

BookStack is a free and open source wiki for creating structured, team-friendly documentation. It is open source and self-hosted, installable on Docker Hub, Proxmox, Kubernetes (Helm), ZimaOS, TrueNAS, Umbrel and Unraid.

Canonical page: https://ourlocalhost.com/app/364/bookstack

## Description

BookStack is a free and open source wiki for creating structured, team-friendly documentation. It features a WYSIWYG (what-you-see-is-what-you-get) editor with a Markdown alternative, runs on MySQL, and supports role-based access control, making it a low-maintenance self-hosted knowledge base for teams and homelab users.

## Platform availability

Available on 6 of 9 platforms: Unraid, TrueNAS, Umbrel, ZimaOS, Proxmox, Helm.

## Health score

86/100 (Excellent), based on 4 of 4 factors.
- Maintained: 100 (last commit 17 days ago)
- Popular: 60 (1,008 GitHub stars)
- Easy to install: 85 (6 install platforms, install notes, Docker image)
- Light to run: 95 (512 MB minimum RAM, runs on ARM)

## Links

- Official website: https://www.bookstackapp.com
- Docker Hub: https://hub.docker.com/r/linuxserver/bookstack
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=bookstack
- Kubernetes (Helm): https://artifacthub.io/packages/helm/gabe565/bookstack
- ZimaOS: https://github.com/bigbeartechworld/big-bear-casaos/tree/master/Apps/bookstack
- TrueNAS: https://apps.truenas.com/catalog/bookstack/
- Umbrel: https://apps.umbrel.com/app/bookstack
- Unraid: https://ca.unraid.net/apps/bookstack-0arn7j70elx97j?q=bookstack
- GitHub: https://github.com/linuxserver/docker-bookstack

## Common questions

### What CLI steps are required for a manual BookStack installation?

Run php artisan key:generate and php artisan migrate in the BookStack folder. The key protects sensitive data, and migration creates the database structure BookStack needs to start.

### How can I create a restorable BookStack backup before changing settings or updating?

Use the BookStack system CLI backup command to save a ZIP of your database, settings file, and optional uploads or themes. Keeping this file lets you restore notes, logins, and configuration if something goes wrong.

### How do I pull the LinuxServer.io BookStack container?

Pull the LinuxServer.io BookStack latest image. Docker uses a manifest for multi-platform awareness to retrieve the appropriate architecture.

### What content hierarchy does BookStack use for organizing documentation?

BookStack uses shelves, books, chapters, and pages. This structure can map an organization, project, and step hierarchy.

## Alternatives

- An-Otter-Wiki
- Confluence: Confluence is Atlassian's self-hosted team wiki for creating, organizing, searching, and sharing project documentation with permissions, ve…
- Docmost: Docmost is an open-source, self-hosted collaborative wiki and knowledge base that lets teams create, edit, and share structured documentati…
- DokuWiki: DokuWiki is a self-hosted, database-free open-source wiki that stores pages as plain text files.
- Foam: Foam is a personal knowledge management and sharing system inspired by Roam Research, built on Visual Studio Code and GitHub.
- GitBook: GitBook is a tool for building beautiful books using Git and Markdown.
- Gollum: Gollum is a simple Git-backed wiki for self-hosting lightweight documentation pages in a versioned repository, letting users edit markup fi…
- HelixNotes: HelixNotes is a local markdown note-taking app built with Rust, Tauri 2.0, and SvelteKit.
- MediaWiki: MediaWiki is a free and open-source wiki engine that powers Wikipedia and the other Wikimedia projects, bundled here with the VisualEditor…
- Notesnook: Fully open-source, end-to-end encrypted notes with device-based security, secure sync, offline access, powerful editor, vault, backups, and…
- Proton Docs
- TiddlyWiki: TiddlyWiki is a single html file with all the characteristics of a wiki - including all of the functionality (including editing, saving, ta…

---
Source: Our Local Host (https://ourlocalhost.com/app/364/bookstack), the self-hosted and open-source app directory.