Skip to content

badstreff/teenyopds

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

teenyopds

Small flask based opds catalog designed to serve a directory via OPDS, it has currently only been verified to work with KyBook 3 on iOS but should work with other OPDS compatible ereaders.

Quickstart

docker build . -t teenyopds

docker run -p 5000:5000 -v /path/to/content:/library teenyopds

Navigate to http://localhost:5000/catalog to view opds catalog

Configuration

The following environment variables can be set

CONTENT_BASE_DIR to server an alternative directory

TEENYOPDS_ADMIN_PASSWORD password for content and catalog, if not set the content and catalog will be available publicly

Other endpoints

/heathz will return "ok" if the service is up and running

Supported Readers

Any reader that supports OPDS should work, however the following have been verified to work/not work

App Android iOS
KyBook 3 - ✔️
Aldiko Next ✔️
PocketBook - ✔️
Moon+ Reader ✔️ -

TODO

Implement simple searching

Metadata lookup based either filename or some type of metadata file populated by the user, one idea is to just have the users put the ISBN in the filename

Support basic auth

I believe OPDS supports content compression however kybook doesn't like it so it's not implemented

About

small opds server

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published