Skip to content

woliveiras/bookaneer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

215 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Bookaneer

A self-hosted ebook collection manager. Combines features from Readarr and LazyLibrarian into a single binary (~20 MB Docker image) targeting home users, NAS devices, and Raspberry Pi.

Bookaneer Mascot

Features

  • Library management — Scan existing ebooks, organize by author/series, fetch metadata
  • Web reader — Read EPUBs directly in your browser (powered by Foliate-js)
  • OPDS catalog — Access your library from any OPDS-compatible reading app
  • Automatic search — Find books via Newznab/Torznab indexers (optional)
  • Download integration — qBittorrent, Transmission, SABnzbd, NZBGet (optional)
  • Notifications — Webhook, Discord, email, and more

Quick Start

docker run -d \
  --name bookaneer \
  -p 9090:9090 \
  -v bookaneer_data:/data \
  -v /path/to/books:/library \
  --restart unless-stopped \
  ghcr.io/woliveiras/bookaneer:latest

Open http://localhost:9090 to access the web UI. The admin password is printed in the container logs:

docker logs bookaneer 2>&1 | grep "Password:"

To access from another device on your network, use http://<your-ip>:9090.

See the full Docker Deployment Guide for Docker Compose setup, environment variables, backups, and troubleshooting.

API Documentation (Swagger)

Bookaneer ships with built-in API documentation via Swagger UI:

  • Swagger UI: http://localhost:9090/api/v1/docs
  • OpenAPI spec (JSON): http://localhost:9090/api/v1/docs/openapi.json

OPDS Catalog

Bookaneer exposes an OPDS 1.2 catalog so you can browse and download books from any OPDS-compatible reading app (KOReader, Moon+ Reader, Librera, Calibre, etc.).

Base URL: http://localhost:9090/opds

Available feeds

Feed URL Description
Root /opds Navigation catalog (entry point)
By Author /opds/authors Browse authors who have files
Author books /opds/authors/:id Books by a specific author
Recent /opds/recent Recently added books
Search /opds/search?q=term Search books by title or author

Setup in reading apps

  1. Open your OPDS-compatible reading app
  2. Add a new OPDS catalog/library
  3. Enter the URL: http://<your-server>:9090/opds
  4. Books with files will appear for download in EPUB, PDF, and other formats

Documentation

Tech Stack

  • Backend: Go 1.26+, Echo v4, SQLite (WAL mode)
  • Frontend: React 19, Vite, TanStack Query, shadcn/ui
  • Web Reader: Foliate-js (MIT)

Legal Disclaimer

Bookaneer is intended for managing legally obtained ebooks. The developers do not condone, encourage, or promote copyright infringement or piracy in any form.

This software:

  • Is designed to organize and read ebooks you already own
  • Integrates with standard protocols (Newznab/Torznab, OPDS) used by many legitimate services
  • Does not host, distribute, or provide access to copyrighted content
  • Does not circumvent or remove DRM — files with DRM protection will not open

Users are solely responsible for ensuring their use of this software complies with all applicable copyright laws in their jurisdiction.

The authors and contributors of this project assume no liability for any misuse of this software.

License

This project is licensed under the GNU General Public License v3.0 — see the LICENSE file for details.

Contributing

Contributions are welcome! Please read AGENTS.md for project guidelines and conventions before submitting PRs.

About

A self-hosted ebook collection manager

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages