# Inkheart

> Inkheart is a self-hosted, open-source PDF library indexer and reader: folder-tree catalogue, full-text search, integrated PDF.js reader.

- **Category:** [Document Management](https://selfhost.directory/document-management)
- **Licence:** apache-2.0
- **Source model:** Open source
- **Latest version:** 1.3.1
- **Author:** Nystik
- **Platforms:** Docker Compose
- **Ports:** 8080 (HTTP server for the web UI and API (BIND_PORT))
- **Tags:** library, Document Management, PDF, Full Text Search, Svelte, Docker, Rust, Indexer, Ebook reader, Pdfjs, Pdf Reader, Firebase Auth

## Docker images

- [`nobbe/inkheart`](https://hub.docker.com/r/nobbe/inkheart)

## What is Inkheart?

For someone who keeps documents in ordinary folders on disk, Inkheart turns that directory into a browsable web library. Rust serves the backend while a Svelte single-page app renders the interface, and nothing lives in a database: the tree you browse simply mirrors what the media folder holds. Covers come from each document's first page, while smaller per-page images are pulled out on request so shared links get OpenGraph previews. Text scraped from all pages feeds a search index, so you can look inside documents rather than only at file names, with bookmark entries and all-caps headings boosted in the ranking. Reading happens in a bundled PDF.js viewer with page-level permalinks, an embed mode and automatic remembering of where you stopped. Grouping is done with collections and pinned sidebar folders. Operationally it is one container image for AMD64 and ARM64, tuned through environment variables or a TOML file, plus volumes for media, covers, thumbnails and persisted config. Guarding access is optional: a Firebase sign-in gate with an account-ID whitelist, or nothing at all if you front it with Authelia, basic auth or a VPN, since there is no concept of multiple users and no OIDC support. Anonymous install-count telemetry runs by default but can be turned off. The author lists real caveats: no metadata storage, an in-memory file index that may scale badly on huge collections, and a slow first text-extraction pass. Development is a personal side project, and native non-Docker builds are not actively planned.

## Should you self-host Inkheart?

Inkheart scores **53/100** on selfhost.directory ([how scoring works](https://selfhost.directory/scoring)) and ranks **#30 of 47** in [Document Management](https://selfhost.directory/document-management).

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is easy: most people get it running in one sitting. An official Docker image is available. It is apache-2.0-licensed.

Its closest alternative on selfhost.directory is [Stirling-PDF](https://selfhost.directory/project/stirling-pdf) (88/100, 96 746 stars). It scores higher overall, so compare the two before you pick. [See Inkheart vs Stirling-PDF side by side.](https://selfhost.directory/compare/inkheart-vs-stirling-pdf)

## Features

- Collections
- Cover extraction
- Direct page links
- Embeddable reader
- Filename search
- Filesystem-based library
- Full-Text Search
- Integrated PDF reader
- OpenGraph page previews
- Optional access control (◐ partial) — No multi-user concept; auth is an optional Firebase gate with a whitelist.
- Pinned folders
- Reading progress tracking

## How to install Inkheart

### Install Inkheart with Docker Compose

Environment variables:

```
MEDIA_DIR, IMAGE_DIR, THUMBNAIL_DIR, CONFIG_PATH, BIND_ADDR
```

```yaml
services:
  inkheart:
    image: nobbe/inkheart:latest
    container_name: inkheart
    network_mode: bridge
    ports:
      - 8080:8080/tcp
    volumes:
      - /path/to/media:/media # The path where you're storing your PDF files
      - /path/to/covers:/covers # First page of each file is extracted here as a library cover
      - /path/to/thumbnails:/thumbnails # Page thumbnails generated for OpenGraph preview when linking
      - /path/to/config:/config # User data: pins, collections, settings, full-text search index, optional auth files. Persist this volume to keep your data and avoid re-indexing on restart.
    environment:
      - MEDIA_DIR=/media
      - IMAGE_DIR=/covers
      - THUMBNAIL_DIR=/thumbnails
      - CONFIG_PATH=/config/inkheart.toml # path to a config file
      - BIND_ADDR=0.0.0.0 # Only needed if you want to change from default
    restart: always
```

Note: Multi-architecture images for AMD64 (x86_64) and ARM64 (aarch64); Docker pulls the right one automatically. Ensure the volume mount paths exist before starting the container to avoid permission issues.

## Inkheart alternatives

- [pdfmanager](https://selfhost.directory/project/pdfmanager): Self-hosted PDF manager offering annotations, nested collections, OIDC authentication, multi-user libraries, sharing, full-text search, and OPDS access for e-readers. (compare: https://selfhost.directory/compare/inkheart-vs-pdfmanager)
- [Readur](https://selfhost.directory/project/readur): Self-hosted OCR document management system with multi-language support, full-text search, and S3/WebDAV sync for individuals and teams. (compare: https://selfhost.directory/compare/inkheart-vs-readur)
- [Bookshelf](https://selfhost.directory/project/bookshelf-2): Self-hosted ebook library for EPUBs/PDFs with OPDS catalog for e-readers, browser readers, and multi-reader profiles. Runs on Cloudflare R2 or local filesystem. (compare: https://selfhost.directory/compare/bookshelf-2-vs-inkheart)
- [shelfmark](https://selfhost.directory/project/shelfmark): Open-source self-hosted web UI to search, request, and download ebooks and audiobooks from Prowlarr, Usenet, IRC, or direct sources, with multi-user requests. (compare: https://selfhost.directory/compare/inkheart-vs-shelfmark)
- [i-librarian-free](https://selfhost.directory/project/i-librarian-free): I, Librarian is a self-hosted, open-source PDF management platform for research teams with AI chat, summaries, and search across PubMed, Crossref, IEEE. (compare: https://selfhost.directory/compare/i-librarian-free-vs-inkheart)
- [Sake](https://selfhost.directory/project/sake): Self-hosted ebook library with web UI, KOReader sync, OPDS/WebDAV, and search from Anna's Archive, Open Library, Project Gutenberg. (compare: https://selfhost.directory/compare/inkheart-vs-sake)
- [BookHeaven.Server](https://selfhost.directory/project/bookheavenserver): Self-hosted ebook library manager with modern responsive UI, OPDS support, KOReader sync, metadata handling, progress tracking, font management, and multiple profiles. (compare: https://selfhost.directory/compare/bookheavenserver-vs-inkheart)
- [Papra](https://selfhost.directory/project/papra): The minimalistic document archiving platform. (compare: https://selfhost.directory/compare/inkheart-vs-papra)

## More in Document Management

- [inquisitive](https://selfhost.directory/project/inquisitive): Self-hosted personal knowledge base with local LLM chat and RAG for notes, documents, and web links. Runs via Python, FastAPI, Streamlit, and Ollama.
- [Invoice Builder](https://selfhost.directory/project/invoice-builder): Open-source, offline-first invoicing and quoting app for freelancers and small businesses, with PDF export, e-invoices, and a self-hosted Docker web mode.
- [JKinco Listen (Open Edition)](https://selfhost.directory/project/jkinco-listen-open): Self-hosted, open-source AI meeting minutes workbench running offline with FunASR and Ollama, producing formatted DOCX/PDF minutes.
- [JmalCloud](https://selfhost.directory/project/jmal-cloud-server): JmalCloud is a self-hosted, open-source private cloud storage platform with WebDAV, object storage backends, OnlyOffice integration, and full-text search.
- [JmalCloud](https://selfhost.directory/project/jmal-cloud-view): Self-hosted, open-source personal cloud drive: online Office editing, previews, WebDAV mounting, resumable big uploads and full-text search, shipped as a Docker image.
- [judicex](https://selfhost.directory/project/judicex): Judicex is a self-hosted legal AI workspace for lawyers to ingest sources, run workflow checks, generate drafts, and chat with an LLM bound to evidence in SQLite
- [LibreOffice (LinuxServer.io)](https://selfhost.directory/project/libreoffice-linuxserverio): Self-hosted Docker container streaming LibreOffice to a browser via HTTPS using the Selkies platform.
- [LibreSign](https://selfhost.directory/project/libresign): Control how your documents get signed
- [Mayan EDMS](https://selfhost.directory/project/mayan-edms): Self-hosted open-source DMS with OCR, document versioning, workflows, fine-grained permissions, smart links and a REST API, deployed via Docker Compose or Helm.
- [Memorwise](https://selfhost.directory/project/memorwise): Self-hosted NotebookLM alternative for document chat with any LLM. Drop in files/links — local RAG Q&A, knowledge graphs, flashcards, quizzes, audio. One command.
- [mike](https://selfhost.directory/project/mike): Open-source self-hosted legal AI for contracts, case research, document analysis. Lets law firms control data, workflows without vendor lock-in. Runs locally via Docker.
- [Nextcloud Office](https://selfhost.directory/project/nextcloud-office): 📑 Collabora Online for Nextcloud

## Links

- [Homepage](https://gitlab.com/Nystik/inkheart)
- [Source repository on GitLab](https://gitlab.com/Nystik/inkheart)
- [Docker Hub image](https://hub.docker.com/r/nobbe/inkheart)
- [Inkheart on Ko-fi (development updates)](https://ko-fi.com/nystik/posts)

---
Source: https://selfhost.directory/project/inkheart