FrederikBaerentsen
/
ComicOPDS
1
0
Fork 0
Code Issues 9 Pull Requests Projects Releases Wiki Activity
ComicOPDS is a lightweight OPDS server written in Python and Flask that allows you to browse your cbz files using OPDS.
61 Commits 1 Branch 0 Tags 204 KiB
Python 91.2%
HTML 5.6%
Jinja 2.9%
Dockerfile 0.3%
Go to file
Frederik Baerentsen 41382cf1cd Started working on #15. Added status page for Generate 2024-02-03 18:09:31 -05:00
opds Started work on search 2024-02-02 09:06:52 -05:00
static initial commit 2022-06-07 09:16:43 +02:00
templates Started working on #15. Added status page for Generate 2024-02-03 18:09:31 -05:00
.dockerignore added ignore files 2022-06-23 09:16:57 +02:00
.gitignore Updated gitignore 2023-05-17 21:01:38 +02:00
Dockerfile initial commit 2022-06-07 09:16:43 +02:00
README.md added supported readers section 2023-01-20 09:42:03 +01:00
README.md.old Started new README with installation instructions 2022-06-07 16:51:19 +02:00
config.py Started working on #15. Added status page for Generate 2024-02-03 18:09:31 -05:00
db.py working on comicdb.xml import 2022-06-09 15:43:50 +02:00
docker-compose.yml Started work on search 2024-02-02 09:06:52 -05:00
extras.py Fixed xml escape issue 2024-01-29 13:59:33 -05:00
import.py added manual import test 2022-06-07 21:41:36 +02:00
main.py Started working on #15. Added status page for Generate 2024-02-03 18:09:31 -05:00
metadata.py initial commit 2022-06-07 09:16:43 +02:00
queryTest.py Starting json2query in catalog.py 2022-06-07 16:16:18 +02:00
requirements.txt Fixed compose thumbnails folder and docker config and requirements updated 2024-01-29 05:34:17 -05:00
test.json Added new json search cases 2023-01-19 22:22:04 +01:00

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