> ## 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.

# Calibre-Web

> Calibre-Web lets you browse and read books from an existing Calibre library.

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/calibreweb.svg?fit=max&auto=format&n=EGkEWLTQnOwecqNx&q=85&s=136d641f18dd8e9b6444622194a750eb" alt="Calibre-Web logo" aria-hidden="true" width="24" height="24" data-path="assets/use-case-logos/calibreweb.svg" />

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

Calibre-Web needs an existing Calibre library (`metadata.db`) in `/books`. The `/config` volume holds Calibre-Web's own users and settings; a separate Towbar Datastore is not used.

## Towbar manifest

```yaml title=".towbar/services/calibre-web.service.yml" theme={"system"}
id: calibre-web
name: Calibre-Web
buildServer: null
deployment:
  type: image
  image: lscr.io/linuxserver/calibre-web:0.6.24
container:
  port: 8083
  volumes:
    - name: config
      mountPath: /config
      initialData: image
    - name: books
      mountPath: /books
      initialData: image
environments:
  production:
    server: 192.0.2.10
rollout:
  type: recreate
  maintenanceMode: true
  reason: Persistent application data uses a single writer
domains:
  primary: calibre-web.example.com
tls:
  mode: direct
```

## 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. 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.
3. Deploy the Service, then perform the checks below before enabling auto-deploy.
4. After deployment, transfer an existing Calibre library to the server and use `docker cp` to place the whole library, including `metadata.db`, under `/books` in the running container.

## Verify

Import a real Calibre library into `/books`, point the first-run form at `/books/metadata.db`, and open a book. An empty volume cannot be used as a library.

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