Skip to content

BookStack

BookStack is a wiki. This shows pages, chapters, books and shelves.

Sign-in: An API key, sent as Authorization: Token.

config.yaml
integrations:
bookstack:
type: bookstack
url: http://bookstack:8080
key: ${BOOKSTACK_KEY}
layout:
- title: Apps
widgets:
- bookstack.status
OptionTypeDefaultWhat it does
urlURLrequiredWhere the service answers, from Valet’s side.
hrefstringoptionalWhere the card links to, when that differs from url.
everystring or numberoptionalHow often to refresh while someone is looking: seconds, or 30s, 5m, 1h.
insecurebooleanoptionalAccept a self-signed certificate for this service only.
keystringrequiredIts API key or token. Use ${VAR}, so it stays out of the file.

One widget. Its key is bookstack.status, using the instance name from your config.

bookstack.status · stats card · refreshes every minute while the page is open.

BookStack, BookStack, small size
Small
BookStack, BookStack, wide size
Wide
BookStack, BookStack, medium size
Medium
BookStack, BookStack, large size
Large
BookStack, BookStack, in chat
In chat

Tall draws the same as medium, so it isn't shown. Only the empty space changes.

BookStack BookStack: Can't reach it
Can't reach it

What the assistant can use, once its access level allows it. Read tools run freely. Everything else asks first.

ToolAccessWhat it does
bookstack_statusreadWhat BookStack reports right now: Pages, Chapters, Books, Shelves.