BookStackInstall

Overview

This node integrates with BookStack, a documentation and knowledge management platform. It allows users to manage various BookStack resources such as books, pages, chapters, shelves, and perform global operations like searching content or retrieving audit logs.

The Global - Search operation enables users to search across all BookStack content types (books, chapters, pages, shelves) using a query string. This is useful for quickly finding relevant documentation or information stored in BookStack without manually browsing through each resource type.

Practical examples:

• Searching for "docker" to find all related books, pages, or chapters about Docker.
• Filtering search results to only show "Books" or "Pages".
• Paginating through large sets of search results by specifying page number and limit.

Properties

Output

The output is an array of JSON objects representing the search results returned by the BookStack API. Each object corresponds to a matched content item and includes its details as provided by the API.

• The json field contains the data of each search result item.
• There is no binary data output for this operation.

Dependencies

• Requires an API key credential for authenticating with the BookStack API.
• The node uses HTTP requests to communicate with the BookStack server's REST API endpoints.
• No additional external services are required beyond access to a BookStack instance.

Troubleshooting

• Common issues:

  • Invalid or missing API credentials will cause authentication errors.
  • Providing an empty search query will trigger a validation error.
  • Requesting too many results (above 500) will be capped automatically by the node.
  • Pagination parameters out of range may lead to empty results.

• Error messages:

  • "Either book_id or chapter_id must be provided when creating a page" — not applicable here but indicates required fields for page creation.
  • Errors from the BookStack API are wrapped and rethrown with their message; check the message for details.
  • "query" parameter is required if the search query is missing.

• Resolution tips:

  • Ensure the API key is valid and has sufficient permissions.
  • Always provide a non-empty search query.
  • Use reasonable limits and page numbers within the allowed ranges.

Links and References

• BookStack Official Documentation
• BookStack API Documentation
• n8n Documentation on Creating Custom Nodes