← Endpaper

Setup

Endpaper runs on your own computer. Install it with one command, then open the address it prints in your browser.

curl -fsSL https://endpaper.org/install.sh | sh

The installer downloads Endpaper, sets it up as a background service, and starts the reader on your computer.

Windows

There is no native Windows installer yet. Run Endpaper through WSL, which is Microsoft's built-in Linux environment. You set WSL up once, then run the same command inside it.

  1. Open PowerShell as administrator and run wsl --install, then restart your computer.
  2. Open the Ubuntu terminal that WSL installed for you.
  3. Run the install command above inside that terminal.

Pointing it at your books

When you first open Endpaper, it asks you to create an admin account. After that, open Manage and set the library folder to wherever your ebooks live. Endpaper watches that folder and adds new books as they appear.

Docker

If you already run Docker, use this compose snippet. Point the books volume at your library, run docker compose up -d, and open http://localhost:8082.

services:
  endpaper:
    image: ghcr.io/danieldelaney/endpaper:latest
    ports:
      - "8082:8082"
    volumes:
      - ./data:/data
      - /path/to/your/books:/books
    restart: unless-stopped

E-readers (KOReader, OPDS)

Endpaper speaks OPDS, so any OPDS-compatible reader (KOReader, Thorium, Foliate, Moon+ Reader) can browse and download from your library. Add a catalog at http://your-server:8082/opds using your Endpaper username and password.

For KOReader's built-in progress sync, generate a sync key in Endpaper's Manage → Users page (edit your user, find the e-reader sync row). Enter that key as the password in KOReader's sync settings, with your server address as the sync URL.

Updating

To update Endpaper, run the install command again. It downloads the latest version and restarts the service. Your books, reading history, and settings are preserved.

curl -fsSL https://endpaper.org/install.sh | sh

If you installed via Docker, pull the latest image and recreate the container:

docker compose pull && docker compose up -d

Uninstall

curl -fsSL https://endpaper.org/install.sh | sh -s -- --uninstall

This stops the service and removes the program. Your books and your reading history are left in place; nothing is deleted.

Coming later

A native app for macOS and Windows, so you can install Endpaper without using the terminal.