What is BookStax?

BookStax is a native iOS app that lets you access and manage your self-hosted BookStack instance directly from your iPhone or iPad. It provides a clean, mobile-first interface for reading, creating, and editing your documentation — wherever you are.

Do I need a BookStack account to use BookStax?

Yes. BookStax connects to an existing self-hosted BookStack instance. You need a running BookStack server and valid user credentials (or an API token) to log in. BookStax does not provide or host BookStack for you.

Is BookStax free?

BookStax is available on the App Store. Check the current pricing on the App Store listing. There is no subscription — it’s a one-time purchase.

Which platforms does BookStax support?

BookStax is a native SwiftUI app for iOS and iPadOS. An iPhone or iPad running iOS 16 or later is required. A macOS version (via Mac Catalyst) is not available at this time.

Setup & Connection

How do I connect BookStax to my BookStack server?

When you first open BookStax, you’ll be prompted to enter your BookStack server URL (e.g. https://bookstack.yourdomain.com) along with your API Token ID and Token Secret. You can generate these in your BookStack user profile under API Tokens.

Where do I find my BookStack API Token?

Log into your BookStack instance, click your profile icon in the top right, go to Edit Profile, and scroll down to the API Tokens section. Create a new token — BookStax needs both the Token ID and the Token Secret. Store the secret safely, as it won’t be shown again.

Can I connect to multiple BookStack instances?

Yes. BookStax supports multiple server profiles. You can add and switch between different BookStack instances from the app settings.

My server uses a self-signed certificate. Will BookStax work?

BookStax requires a valid HTTPS connection to your BookStack instance. Self-signed certificates are not trusted by iOS by default. We recommend using a proper TLS certificate — free options like Let’s Encrypt work perfectly. If your server is behind a reverse proxy (e.g. Caddy or Nginx), TLS termination is typically handled there.

Can I use BookStax with a locally hosted BookStack (no public domain)?

Yes, as long as your iOS device can reach the server. This works when you’re on the same local network (e.g. home Wi-Fi), or via VPN when you’re away from home. A valid HTTPS connection is still required — you can use a local DNS override and a wildcard or domain certificate for this.

I get a connection error / 403 Forbidden. What should I check?

• Make sure your server URL does not have a trailing slash.
• Verify the API Token ID and Secret are entered correctly.
• Check that your reverse proxy forwards the Authorization header to BookStack (some proxies strip custom headers by default).
• Ensure the BookStack API is enabled in your instance settings (Settings → API).
• If you use bot protection (e.g. Anubis or Cloudflare), make sure the /api/ path is not blocked for API clients.

Features

What can I do with BookStax?

BookStax lets you:

• Browse your BookStack shelves, books, chapters, and pages
• Read page content with a clean, readable layout
• Create and edit pages directly on your device
• Search across your entire BookStack library
• Access recently viewed content quickly
• Work with content while offline (cached pages)

Does BookStax support offline reading?

Yes. Pages you’ve previously opened are cached locally on your device using SwiftData, so you can read them without an active connection to your server. Changes made offline will sync when you reconnect.

Can I create and edit pages in BookStax?

Yes. BookStax includes an editor for creating new pages and editing existing ones. You can write content in Markdown, which is then saved back to your BookStack instance via the API.

Does BookStax support attachments and images in pages?

Images embedded in pages are rendered inline when reading. Uploading new images or managing attachments from within the app is a planned feature for a future release.

Is there a search function?

Yes. BookStax uses the BookStack search API to let you search across all shelves, books, chapters, and pages in your instance. Results are displayed with context so you can quickly find what you’re looking for.

Does BookStax support Dark Mode?

Yes. BookStax fully supports iOS Dark Mode and follows your system appearance setting automatically. You can also override this in the app settings if you prefer a fixed theme.

Privacy & Security

Does BookStax collect any data?

No. BookStax does not collect, transmit, or share any personal data. All communication happens exclusively between your device and your own BookStack server. Your API credentials are stored securely in the iOS Keychain.

Where are my login credentials stored?

Your API Token ID and Secret are stored in the iOS Keychain — the same secure enclave used by iOS itself for passwords and authentication data. They are never stored in plain text or transmitted to any third party.

Does BookStax use any third-party analytics or tracking SDKs?

No. BookStax contains no third-party analytics, advertising, or tracking libraries. The app has no external dependencies beyond the standard Apple frameworks.

Troubleshooting

The app shows “Unable to connect to server”. What can I do?

First, verify that your BookStack instance is reachable in a browser on the same device. Then check:

• The server URL in BookStax matches the address you use in the browser (including https://).
• Your device has an active internet connection or is on the correct local network.
• No firewall or VPN is blocking access.
• If you’re using a reverse proxy, ensure it’s forwarding API requests correctly.

Pages load in the browser but not in BookStax. Why?

This usually means the API is either disabled or blocked. Check that the BookStack API is enabled in your admin settings, and that your reverse proxy does not block or strip requests to the /api/docs or /api/v1/ paths.

How do I reset my server connection?

Go to Settings → Servers in BookStax, select your server, and choose Edit or Remove. You can then re-enter your credentials or add a new server profile from scratch.

I found a bug. How do I report it?

Please use the support form or send an email to the address listed in the App Store. Include your iOS version, BookStax version, and a short description of what happened. Screenshots or screen recordings are always helpful.

Updates & Roadmap

How often is BookStax updated?

Updates are released as new features are ready and bugs are fixed. You can enable automatic updates in the App Store settings to always stay on the latest version.

Is there a feature I can request?

Absolutely. Feature requests are very welcome — use the support form or reach out via the App Store. The most-requested features are tracked and prioritized for upcoming releases.

Is an Android version planned?

BookStax is currently an iOS/iPadOS-only app built with SwiftUI, which is Apple-exclusive technology. An Android version is not planned at this time.

For more background on the app, head to the home page. Release notes are in the BookStax section. Direct contact via the support form.