docs/user-facing/media-and-entertainment/calibre-web.md

# Calibre-Web: E-Book Library & Sync

**Calibre-Web** is the digital book library for **The Nest**. It provides a clean interface to browse, read, and manage your e-book collection, complete with in-browser reading, e-reader sync support, and automatic reading tracking.

---

## 1. Getting Started & Reading Online

1. Visit **[rookery.mynest.love](https://rookery.mynest.love)** in your web browser.
2. Click **Sign In** and select **"Sign in with The Nest"**.
3. Log in using your standard Nest passkey.
4. Search or browse through the library by title, author, series, or tag.
5. Click **Read Online** to read directly in your browser, or **Download** to save a copy in your preferred format (EPUB, PDF, MOBI, etc.).

---

## 2. Connecting E-Readers (OPDS & KoSync)

Calibre-Web supports **OPDS** (Open Publication Distribution System) for browsing and downloading books directly on e-readers, as well as **KoSync** for syncing your reading progress and bookmarks across multiple devices.

> [!WARNING]
> **Application Key Required for E-Readers**
>
> Standard passkeys and Single Sign-On do **not** work directly inside third-party e-reader apps. To connect an e-reader app, you must generate a dedicated **Application Key**:
> 
> 1. Log in to [rookery.mynest.love](https://rookery.mynest.love) in your web browser.
> 2. Open your **Account Settings**.
> 3. Under **Application Keys**, enter a label (e.g., *"KOReader Kobo"* or *"Readest iPhone"*) and click **Generate**.
> 4. **Copy the key immediately!** It will only be displayed once. (We recommend saving it in **Vaultwarden**).

### E-Reader Endpoints & Login Credentials
When logging in from an e-reader app, use the following credentials:
* **Username:** Your Nest username
* **Password:** Your generated **Application Key**

| Protocol | Service URL / Endpoint | Purpose |
| :--- | :--- | :--- |
| **OPDS** | `https://rookery.mynest.love/opds` | Browse and download books directly on your e-reader |
| **KoSync** | `https://rookery.mynest.love/sync` | Sync reading progress and bookmarks across devices |

---

## 3. Recommended E-Reader Clients

You can connect any app that supports OPDS or KoSync. Here are our top recommended e-reader applications:

* **[KOReader](https://koreader.rocks/):** *(Available for Android, Kindle, Kobo, Windows, Linux)* — The premier open-source reading application featuring native OPDS browsing and built-in KoSync support.
* **[Readest](https://readest.app/):** *(Available for iOS)* — A sleek, modern e-reader app for iPhone and iPad with built-in OPDS support.

> [!TIP]
> **Have a Kindle?**
> If you'd like to install KOReader on a Kindle, check out [Kindle Mod Shelf](https://kindlemodshelf.me/) for jailbreaking guides! Alternatively, you can use the web interface's *"Send to Kindle"* feature to deliver EPUB or MOBI files directly to your Amazon account.

---

## 4. Where Does Content Come From?

To keep metadata, covers, and series details clean and consistent, direct file uploads inside Calibre-Web are disabled.

* **Requesting New Books:** Request any e-book title via **[Shelfmark](../media-request/shelfmark.md)**! Shelfmark automatically fetches high-quality metadata and imports the book directly into Calibre-Web.
* **Contributing Existing Libraries:** Have a large collection of e-books you'd like to share with The Nest? Reach out to an administrator on Matrix to arrange a batch import!

---

## 5. Hardcover Reading Tracker Integration

Love tracking your reading stats and sharing book reviews? Calibre-Web integrates natively with **[Hardcover](https://hardcover.app)**:

1. Create a free account at [hardcover.app](https://hardcover.app).
2. Generate an **API Token** in your Hardcover account settings.
3. Paste the token into your Calibre-Web account settings on [rookery.mynest.love](https://rookery.mynest.love).

Once linked, books you read in Calibre-Web will automatically sync with your Hardcover profile!

---

## 6. Supported File Formats

* **EPUB:** The recommended standard for e-readers, mobile apps, and web reading. *(Most non-EPUB formats are automatically converted to EPUB upon import).*
* **PDF:** Ideal for fixed-layout documents, comics, and technical manuals.
* **MOBI / AZW3:** Amazon Kindle legacy formats.
* **TXT:** Plain text files.

---

## 7. Service Summary & Related Links

| Component | URL / Endpoint | Purpose |
| :--- | :--- | :--- |
| **Calibre-Web UI** | [rookery.mynest.love](https://rookery.mynest.love) | Web interface, online reading, and account settings |

### Related Nest Documentation:
* **[Shelfmark](../media-request/shelfmark.md):** Request new e-books to automatically populate the library.
* **[Audiobookshelf](../media-and-entertainment/audiobookshelf.md):** Listen to audiobooks and podcasts.