> ## Documentation Index
> Fetch the complete documentation index at: https://www.towbar.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# BookStack

> BookStack organizes documentation into books, chapters, and pages for teams.

export const UseCaseNavigation = () => {
  useLayoutEffect(() => {
    const storageKey = "towbar-use-case-open-groups";
    const groupSelector = "#sidebar li[data-title] > button[aria-expanded]";
    let restoring = false;
    let frame = 0;
    function storedGroups() {
      try {
        return new Set(JSON.parse(sessionStorage.getItem(storageKey) || "[]"));
      } catch {
        return new Set();
      }
    }
    function save(groups) {
      try {
        sessionStorage.setItem(storageKey, JSON.stringify([...groups]));
      } catch {}
    }
    function groupName(button) {
      return button.parentElement?.dataset.title;
    }
    function rememberOpenGroups() {
      const groups = new Set();
      for (const button of document.querySelectorAll(groupSelector)) {
        if (button.getAttribute("aria-expanded") === "true") {
          const name = groupName(button);
          if (name) groups.add(name);
        }
      }
      save(groups);
    }
    function restoreOpenGroups() {
      frame = 0;
      const groups = storedGroups();
      if (!groups.size) return;
      restoring = true;
      for (const button of document.querySelectorAll(groupSelector)) {
        if (groups.has(groupName(button)) && button.getAttribute("aria-expanded") === "false") {
          button.click();
        }
      }
      restoring = false;
    }
    function scheduleRestore() {
      if (!frame) frame = requestAnimationFrame(restoreOpenGroups);
    }
    function onClick(event) {
      if (restoring || !(event.target instanceof Element)) return;
      const button = event.target.closest(groupSelector);
      if (button) {
        const name = groupName(button);
        if (!name) return;
        const groups = storedGroups();
        if (button.getAttribute("aria-expanded") === "true") groups.delete(name); else groups.add(name);
        save(groups);
        return;
      }
      if (event.target.closest('a[href^="/docs/use-cases/"]')) {
        rememberOpenGroups();
      }
    }
    const observer = new MutationObserver(scheduleRestore);
    document.addEventListener("click", onClick, true);
    observer.observe(document.getElementById("sidebar") || document.body, {
      childList: true,
      subtree: true
    });
    scheduleRestore();
    return () => {
      document.removeEventListener("click", onClick, true);
      observer.disconnect();
      cancelAnimationFrame(frame);
    };
  }, []);
  return null;
};

<UseCaseNavigation />

<img className="towbar-doc-brand-logo" src="https://mintcdn.com/avgeek/EGkEWLTQnOwecqNx/assets/use-case-logos/bookstack.svg?fit=max&auto=format&n=EGkEWLTQnOwecqNx&q=85&s=02b0c37aa5e788fb6d0ce2169c80528c" alt="BookStack logo" aria-hidden="true" width="24" height="24" data-path="assets/use-case-logos/bookstack.svg" />

**Upstream source:** [Current installation guide](https://docs.linuxserver.io/images/docker-bookstack/).

MariaDB stores books and users; `/config` holds application files and uploads. Keep the generated `APP_KEY` stable after first deployment.

## Towbar manifests

<CodeGroup>
  ```yaml title=".towbar/datastores/bookstack-mariadb.datastore.yml" theme={"system"}
  id: bookstack-mariadb
  name: BookStack MariaDB
  type: mariadb
  container:
    network: application
    networkAlias: bookstack-mariadb
    resources:
      cpus: 1
      memory: 1g
  secrets:
    runtime:
      - MYSQL_ROOT_PASSWORD
      - MYSQL_DATABASE
      - MYSQL_USER
      - MYSQL_PASSWORD
  environments:
    production:
      server: 192.0.2.10
  ```

  ```yaml title=".towbar/services/bookstack.service.yml" theme={"system"}
  id: bookstack
  name: BookStack
  buildServer: null
  deployment:
    type: image
    image: lscr.io/linuxserver/bookstack:25.07.3
  container:
    port: 80
    network: application
    volumes:
      - name: config
        mountPath: /config
        initialData: image
  environments:
    production:
      server: 192.0.2.10
  rollout:
    type: recreate
    maintenanceMode: true
    reason: Persistent application data uses a single writer
  secrets:
    runtime:
      - APP_URL
      - APP_KEY
      - DB_HOST
      - DB_PORT
      - DB_DATABASE
      - DB_USERNAME
      - DB_PASSWORD
  domains:
    primary: bookstack.example.com
  tls:
    mode: direct
  ```
</CodeGroup>

## Configure

1. Prepare the example server, connect the repository, and map `production` to the branch containing these manifests. Replace the example server IP and domain. Commit the manifests, then sync the repository and inspect the resolved configuration.
2. Save the initialization values in the table below for the mariadb Datastore under **Datastore → Settings → Secrets**. Deploy it first and wait for readiness. These values create the database and user only on an empty volume.
3. Set the Service's declared runtime values under **Service → Settings → Secrets** using the table below. Replace descriptions and placeholders with actual values; do not commit passwords or keys.
4. Keep the Service's named volumes attached across deployments. Towbar's Datastore backup policy does not back up Service volumes, so include them in your own recovery plan.
5. Deploy the Service, then perform the checks below before enabling auto-deploy.

## Datastore values

Save these in each Datastore's **Settings → Secrets** before deploying it. Use the suggested names or choose your own, then use the same names and passwords in the Service connection values below.

| Datastore         | Key                   | Suggested value                                                                           |
| ----------------- | --------------------- | ----------------------------------------------------------------------------------------- |
| BookStack mariadb | `MYSQL_DATABASE`      | bookstack                                                                                 |
| BookStack mariadb | `MYSQL_USER`          | bookstack                                                                                 |
| BookStack mariadb | `MYSQL_PASSWORD`      | Run `openssl rand -hex 32`; save its output and reuse it in the Service connection value. |
| BookStack mariadb | `MYSQL_ROOT_PASSWORD` | Run `openssl rand -hex 32` again for a separate root password.                            |

## Runtime values

Save these values on the Service after the repository sync. The manifest declares required keys, not their values.

| Key           | Value to save                                                  |
| ------------- | -------------------------------------------------------------- |
| `APP_URL`     | [https://bookstack.example.com](https://bookstack.example.com) |
| `APP_KEY`     | Generate with the image's `appkey` command.                    |
| `DB_HOST`     | bookstack-mariadb                                              |
| `DB_PORT`     | 3306                                                           |
| `DB_DATABASE` | Same value as MYSQL\_DATABASE.                                 |
| `DB_USERNAME` | Same value as MYSQL\_USER.                                     |
| `DB_PASSWORD` | Same value as MYSQL\_PASSWORD.                                 |

## Verify

Create a page with an attachment, redeploy, and confirm both are still available.

For field constraints, see [Service manifest](/docs/services/manifest) and [Datastore manifest](/docs/datastores/manifest).