deafmute/calibredb

The following README.md is from https://github.com/deafmute1/docker-calibredb as of 30/07/2021.

docker-calibredb

calibredb is a docker image intended to provide a headless calibre library for use with calibre-web, COPS or similar. It supports automatic imports from a mounted host directory(s), with the ability filter files based on regex patterns and to run custom modification via shell commands to the files prior to import based on subfolders. It includes the calibre plugin DeDRM prebuilt into the image, and allows users to mount their own plugins into the image. Currently, the image provides access to the following packages/binaries (in addition to a regular ubuntu hirsuite install) which can be used to modify files before import:

• calibre
• https://github.com/ciromattia/kcc (kcc-c2e and kcc-c2p)

Get it on https://hub.docker.com/repository/docker/deafmute/calibredb, using tags:

• deafmute/calibredb:latest: builds from master branch.
• deafmute/calibredb:testing: builds from testing branch (not intended for real world use).
• deafmute/calibredb:version-*: builds builds from tagged releases.

Configuration:

Users should set environmnetal variables and mount points as required in docker-compose.yaml or docker run, then view user_config.example.py in order to set an import rule, which comprises a source directory, regex pattern, remove boolean and import command (users can also set a single rule using environmental variables).

user_config.py

This file needs to contain a variable WATCH which is equal to a list of dictionaries with keys:

• source containing a string representing the path to import files from. (Required)
• run containg a string (which may use the token {file} to represent the filepath of each imported file) representing a command to be run at import of each file. (Optional, default is to skip it)
• remove containing a boolean, representing whether files in source should be deleted after import. (Optional, deafult is False)
• pattern containing a string representing a python regex pattern (Optional, default is to skip checking it)

Import Modes

There are three import modes currently:

• NEW: monitors source directory for new files recursively and imports them (default)
• ALL: Every $IMPORT_ALL_TIMER minutes, imports all files in source
• ONESHOT: Import all files in source once, then exit

Please note, calibre is capable of adding literally any file - I've tested things like database files and binaries, and it can add them fine. It does not seem to run any validation on the files as valid ebooks. As such, there is no logging feedback on success of the command, it is assumed that calibredb add is always sucessful. The user should be aware then, that any file addded to source will be imported, unless they make use of pattern.

There is no support for single entries spread across many files (i.e. unpacked comic books), this is due to calibre itself. Packed comic book archives should work fine.

Environmental variables:

Mount points

See above in regards to CALIBRE_LIBRARY, CALIBRE_PLUGIN_DIR, USER_CONFIG_PATH. See config.example.py in regards to setting the location of the source directories to import new files from. In addition, there are some relevant static paths:

TODO

• Allow users to add their own packages for use in run commands, like was done with plugins.
• Allow users to set IMPORT_MODE per rule