ComicOPDS is a lightweight OPDS server written in Python and Flask that allows you to browse your cbz files using OPDS.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Frederik Baerentsen 41382cf1cd Started working on #15. Added status page for Generate 2 months ago
opds Started work on search 2 months ago
static initial commit 2 years ago
templates Started working on #15. Added status page for Generate 2 months ago
.dockerignore added ignore files 2 years ago
.gitignore Updated gitignore 11 months ago
Dockerfile initial commit 2 years ago
README.md added supported readers section 1 year ago
README.md.old Started new README with installation instructions 2 years ago
config.py Started working on #15. Added status page for Generate 2 months ago
db.py working on comicdb.xml import 2 years ago
docker-compose.yml Started work on search 2 months ago
extras.py Fixed xml escape issue 2 months ago
import.py added manual import test 2 years ago
main.py Started working on #15. Added status page for Generate 2 months ago
metadata.py initial commit 2 years ago
queryTest.py Starting json2query in catalog.py 2 years ago
requirements.txt Fixed compose thumbnails folder and docker config and requirements updated 2 months ago
test.json Added new json search cases 1 year ago

README.md

ComicOPDS

ComicOPDS is a lightweight OPDS server written in Python and Flask that allows you to browse your cbz files using OPDS.

Getting Started

The easiest way to get started is to clone the git reposetory, build the docker image and run docker-compose.

Alternativly you can clone the repo and start the flask server using the main file. This requires a bit of configuration.

Prerequisites

  • All comic files needs to be cbz. This doens't work with cbr. I see no reason to use cbr and as such, this project wont support it.

  • All comics must be properly tagged. This means every cbz file must contain a ComicInfo.xml file. You can use various tools to

Docker

Prerequisites

  • Docker
  • Docker-compose

Installing

First clone the git repo.

git clone https://gitea.baerentsen.space/ComicOPDS

Then go to the folder

cd ComicOPDS

Next build the image

docker build . -t comicopds

Adjust the docker-compose file:

<add docker compose example with config options and drive mapping>

Run docker-compose

docker-compose up

Manual Install

To manually install the flask server you need to install the python requirements.

Prerequisites

  • Python3.x

Installing

python3 -m pip install -r requirements.txt

Change configs

In the config.py file you need to change like 4 from "/library" to your comic library. This has only been tested on Debian.

Running

python3 main.py

Supported Readers

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

App iOS
KyBook 3 (iOS) ✔️
Aldiko Next (iOS)
PocketBook (iOS) ✔️
Moon+ Reader (Android) ✔️
Panels (iOS) ✔️
Marvin (iOS) ✔️
Chunky (iOS) ✔️

Notes

5865 files in 359 seconds