Go to file
2024-05-10 17:25:13 +02:00
calibre-db bit of documentation 2024-05-10 14:25:18 +02:00
rusty-library stream books instead of reading them into memory 2024-05-10 17:23:23 +02:00
.containerignore add containerfile 2024-05-10 17:09:07 +02:00
.gitignore bare bones calibre db reading 2024-05-01 16:21:07 +02:00
Cargo.lock stream books instead of reading them into memory 2024-05-10 17:23:23 +02:00
Cargo.toml book feed 2024-05-09 11:18:47 +02:00
Containerfile add containerfile 2024-05-10 17:09:07 +02:00
COPYING correct license file name 2024-05-10 17:25:13 +02:00
deny.toml license as AGPL 2024-05-06 19:33:58 +02:00
flake.lock bare bones calibre db reading 2024-05-01 16:21:07 +02:00
flake.nix license as AGPL 2024-05-06 19:33:58 +02:00
README.md add containerfile 2024-05-10 17:09:07 +02:00

Rusty Library

I have been a long time user of cops and its fork in order to access my ebook collection in a nice way from a browser. My biggest use always has been the ODPS feed for getting all of that from within KOReader.

It so happened that exactly when I was looking for a small side project I also had trouble with a new cops version (not through their fault, only because I insist on writing my own containers). How hard can it be I thought and went on hacking something together. The result does at most one tenth of what cops can do but luckily enough it is the part I need for myself.

Building

Nix

A nix environment with enabled nix-commands in order to use nix develop and nix build.

A statically linked binary for linux systems (using musl) can be compiled by running nix build (run nix flake show to get a list of available targets).

Otherwise run nix develop to be dropped into a shell with everything installed and configured. From there all the usual cargo commands are accessible.

Classic

A recent rust installation is all that is needed.

From there on cargo run and cargo build and so on can be used.

Configuration

The binary takes exactly one argument, the path to the calibre library folder.

The listening port is hardcoded to 3000 for now, as is the listening on all interfaces.

Usage

Run the binary with the calibre library as an argument and open http://localhost:3000 (or wherever it should be accessible). http://localhost:3000/opds is the entry point for the OPDS feed.

FAQ

No authentication?

Not planned, put a reverse proxy in front of it that handles access.

On my todo list once I feel like I need it.

Why are the OPDS entries not paginated?

My hardware (a Kobo Aura One from ~2016) with KOReader works perfectly fine with parsing the 1MB book feed from own library. Once that changes I might get over my laziness and implement it.

Aren't these database access patterns inefficient?

They most probably are but my elaborate testing setup (my own calibre library) works fine with it.

Why rust?

I like the language and wanted to try the poem framework.

Is it webscale?

Go away.