selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

GitLab
Inkheart logo

Self-host Inkheart

1.3.1

Lightweight PDF library reader with full-text search

ReleaseOpen Sourceapache-2.0
Updated3 years ago
Setup difficultyEasy
ThemeDark mode
Port
8080 (HTTP server for the web UI and API (BIND_PORT))
Docker
nobbe/inkheart
Install with Docker Compose

What is Inkheart?

Should you self-host Inkheart?

Inkheart scores 53/100 on selfhost.directory (how scoring works) and ranks #30 of 47 in 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 (88/100, 96 671 stars). It scores higher overall, so compare the two before you pick. See Inkheart vs Stirling-PDF side by side.

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 controlNo 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
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

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.

How to configure Inkheart

  • CONFIG_PATH"./inkheart.toml"Path to configuration file. _Only loaded from environment, ignored when read from config file_
  • CONFIG_DIRParent dir of CONFIG_PATHDirectory for user data (pins, collections, settings). Defaults to parent directory of CONFIG_PATH.
  • MEDIA_DIR"/media"Directory for media files.
  • IMAGE_DIR"/covers"Directory for cover images.
  • THUMBNAIL_DIR"/thumbnails"Directory for thumbnails.

More in Document Management

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…