BookStack

A self-hosted wiki platform for organizing and storing information. Uses an intuitive structure of shelves, books, chapters, and pages to keep your documentation organized.

What You Can Do After Deployment

Visit your domain and log in with the default credentials: [email protected] / password. Change these immediately after first login.

Content organization: Create shelves to group related books, books to hold chapters and pages, and use chapters for logical grouping. Drag and drop to reorder content.

Editing: Choose between a WYSIWYG editor, Markdown editor, or plain HTML editor. Embed images, attachments, code blocks, and diagrams. Supports drawing with the built-in draw.io integration.

Search: Full-text search across all content with filters for tags, creation date, and content type. Search results show context snippets.

Permissions: Granular role-based access control at every level — shelves, books, chapters, and pages. Create custom roles with specific permissions.

API: RESTful API for programmatic access to all content. Generate personal API tokens from your profile.

Export: Export pages and books as PDF, HTML, Markdown, or plain text.

First-Time Setup

1. Log in with [email protected] / password
2. Go to Settings > Users and change the admin email and password
3. Configure your application name and settings under Settings > Application

Configuration

• App URL: Set automatically from your Zeabur domain
• Database: Uses SQLite by default via the linuxserver image — no external database required

License

MIT — GitHub