n8n-nodes-bookstack


This is an n8n community node that lets you use BookStack in your n8n workflows. The n8n project is a fair-code licensed workflow automation platform.

BookStack is an open source, self‑hosted documentation / knowledge base platform for organizing and sharing content via books, chapters, pages, and shelves.

- Installation
- Operations
- Credentials
- Compatibility
- Usage
- Resources
- License
- Contributing
- Security
- Disclaimer

---

Installation

$3

Follow the official guide: Install a community node.

$3

If you are running a self‑hosted n8n and want to build from source:
``bash

Go to your n8n custom folder

mkdir -p ~/.n8n/custom && cd ~/.n8n/custom

Clone the repository

git clone https://github.com/lucaguindani/n8n-nodes-bookstack.git
cd n8n-nodes-bookstack

Install dependencies & build

pnpm install
pnpm run build

Restart n8n so the node is loaded

`
After restart, search for "BookStack" in the node picker.

---

Operations

The node exposes CRUD + search and audit capabilities for core BookStack entities.

Resource: Book
- Get Many / Get / Create / Update / Delete

Resource: Page
- Get Many / Get / Create / Update / Delete

Resource: Chapter
- Get Many / Get / Create / Update / Delete

Resource: Shelf
- Get Many / Get / Create / Update / Delete

Resource: Global
- Search / Audit Log

---

Credentials

You need a BookStack API Token.
1. In BookStack, open: My Account → Access & Security (/my-account/auth)
2. Create a token; copy Token ID and Token Secret
3. In n8n, create new credentials of type "Bookstack API":
- Base URL: e.g. https://your-bookstack.example.com/api
- Token ID
- Token Secret
4. Save and use in the node

Required permission: The token inherits the permissions of the user who created it. Ensure that user can read/create/update intended entities. Audit Log requires permission to manage both users and system settings.

---

Compatibility

Tested with:
- n8n 1.109+
- Bookstack 24.5+
- Node 20+

---

Usage

$3

- Return All: When enabled, the node will automatically paginate through all results.
- Limit: When "Return All" is disabled, sets the maximum number of items to return.
- Sort By / Sort Direction
- Filters (field, operation, value)

Internally, the node handles pagination (count/offset) for you when needed.

$3

- Provide a search query and optionally pick a content type (book, page, chapter, shelf)
- "Return All" / "Limit" to control the amount of results
- "Deep Dive" to automatically fetch full content for all search results. This provides complete context but increases execution time and API calls.

$3

When creating/updating entities, tags can be provided as a comma‑separated list: tagA, tagB.

$3

Common errors are formatted for clarity:
- 401: credentials invalid
- 403: insufficient permissions
- 404: resource not found
- 422: validation issue
- 429: rate limit

---

Resources

* n8n Community Nodes Docs: https://docs.n8n.io/integrations/#community-nodes
* BookStack Documentation: https://www.bookstackapp.com/docs/
* BookStack API Reference: https://demo.bookstackapp.com/api/docs
* BookStack GitHub: https://github.com/BookStackApp/BookStack

---

License

This project is licensed under the MIT License – see LICENSE.md.

---

Contributing

To lunch a local instance, make sure Node 18+ is installed, then run the following from the root directory of the project.

`bash
pnpm install
pnpm run dev
`

You should be able to connect to http://localhost:5678.

Pull requests are welcome. For significant changes, open an issue first to discuss scope.

Before committing, ensure build passes and no lint or formatting errors are found.

`bash
pnpm run lint
pnpm run format
pnpm run build
``

Please provide a clear PR description.

---

Security

Do not commit BookStack credentials. Tokens inherit user permissions—consider creating a dedicated low‑privilege API user.

---

Disclaimer

This community node is not an official BookStack product. Use at your own risk; validate results in critical workflows.