Skip to content

BookStack

Updated

BookStack is a documentation platform built around a structure everyone already understands: shelves hold books, books hold chapters, chapters hold pages. That hierarchy is the whole reason people pick it. A flat pile of markdown files needs discipline to stay navigable; BookStack gives the structure to you up front and makes it hard to lose things.

It ships a WYSIWYG editor alongside a markdown one, so contributors who don't write markdown can still contribute. Full-text search covers everything, pages keep a revision history you can diff and revert, and permissions can be set per shelf, book, chapter, or page.

Good fits: a team handbook, a homelab runbook, a game world's lore bible, a customer-facing knowledge base, or the documentation for a project whose contributors won't touch Git.

Get a 7-day trial of ElfHosted BookStack! πŸͺ„

How do I access BookStack?

BookStack is available:

Signed-in users see their own URLs

The addresses above show the general pattern. Sign in and these become your personal, clickable links.

How do I use it?

First run

BookStack sets up its database on first start, so give it a minute or two before the page loads. Sign in with the default administrator account:

  • Email: admin@admin.com
  • Password: password

Change both immediately under Edit Profile. Your instance sits behind ElfHosted's SSO by default, so this isn't an open door, but it becomes one the moment you turn SSO off (see below).

Structure

Start with a shelf per broad area, a book per topic, and let chapters appear as books grow. You don't have to use every level: pages can live directly in a book. Resist the urge to design the whole tree up front, because moving pages later is a drag-and-drop and costs nothing.

Sharing it with people who don't have ElfHosted accounts

By default BookStack is behind ElfHosted's SSO (ForwardAuth), so its own login is a second layer on top and only you can reach it.

If you want to publish your documentation, or share it with collaborators who aren't ElfHosted customers, use ElfBot to set bookstackexposed.enabled: true. That drops the ElfHosted auth layer entirely and leaves BookStack's own login and permission system in charge.

Before you do that:

  1. Change the default admin credentials, if you somehow still haven't.
  2. Decide what anonymous visitors should see. Settings β†’ Registration controls whether the public can read without an account, and whether they can sign themselves up. Public read with self-registration off is the usual answer.
  3. Set per-shelf and per-book permissions for anything that shouldn't be public.

Importing what you already have

BookStack imports markdown and HTML directly into pages, so a pile of existing notes can be pasted in with formatting intact. There's also a full REST API if you'd rather script a bulk migration than click through it.

Attachments and images

Uploads land on your instance's storage and are backed up along with everything else. Large image-heavy books are fine; the page editor handles paste-from-clipboard.

BookStack or Wiki.js?

They solve overlapping problems differently, and plenty of people run both:

  • BookStack gives you the structure up front, is WYSIWYG-first, and has no Git. Best when the contributors are not all developers.
  • Wiki.js is markdown-native, Git-backed, and flexible about hierarchy. Best when the docs live alongside code and you want them in version control.

BookStack also works with

How do I get support for BookStack?

  1. For general use of BookStack, refer to the official site or to one of the links in the resources section below.

  2. For specific support re your ElfHosted configuration / account, see the ElfHosted support options!

You can contribute directly to the development of BookStack using the following:

BookStack resources

What users say..

We're rocking some excellent ⭐⭐⭐⭐⭐ TrustPilot Reviews, and here's what some of our usersfriends say..

I am absolutely stoked with my experience with ElfHosted! I paid for their Elf Wizard VIP Setup Experience, and it was worth every single penny.

My elf wizard, Waansin, was absolutely fantastic to work with. He was incredibly kind, caring, and clearly knows these products inside and out. He took the time to ensure everything was configured perfectly and got a totally awesome service up and running for me without any hassle.

The range of services ElfHosted offers is fantastic. The platform itself is fast, rock-solid stable, and delivers exactly what I want. What really gives me peace of mind is knowing how stellar their support isβ€”I feel completely confident that if anything ever goes wrong, they will be right there to help me fix it.

If you are on the fence, definitely go for it. Huge thanks to Waansin and the team for the top-tier service!

β˜…β˜…β˜…β˜…β˜… Tim D. (Trustpilot)

A truly wonderful experience so far that is clearly run by people who deeply value integrity when it comes to providing a professional service that also gives back to the developers. The support is 5*, the community feels trustworthy and most of all, it does not exist to suck the life (and money) out of the people that use the service, which is a rare find. A pleasure to use and highly recommend!

β˜…β˜…β˜…β˜…β˜… Rob (Trustpilot)

Top Notch service. Products are a great benefit

β˜…β˜…β˜…β˜…β˜… James D. (Trustpilot)

Simple, straightforward and faultless. Mirrors the rest of the services and support received and can’t rate highly enough

β˜…β˜…β˜…β˜…β˜… customer (Trustpilot)