calibre-web: dtrpg-metadata Initial commit

This adds a new metadata provider to calire-web for retrieving
publication data from drivethrurpg.com
This commit is contained in:
Ross Hendry
2022-09-14 15:46:57 +01:00
parent 413aa5129f
commit 4337200128
7 changed files with 168 additions and 79 deletions
+6 -21
View File
@@ -1,25 +1,10 @@
# Rsync - Docker mod for openssh-server
# Calibre-web - DriveThruRPG Metadata Provider
This mod adds rsync to openssh-server, to be installed/updated during container start.
This adds a new metadata provider for `calibre-web` which will look for information on DriveThruRPG.com
In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync`
After installing, DriveThruRPG will be an option when pulling in metadata about a book.
If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:openssh-server-rsync|linuxserver/mods:openssh-server-mod2`
In `calibre-web` docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:calibre-web-dtrpg-metadata` to enable.
# Mod creation instructions
* Fork the repo, create a new branch based on the branch `template`.
* Edit the `Dockerfile` for the mod. `Dockerfile.complex` is only an example and included for reference; it should be deleted when done.
* Inspect the `root` folder contents. Edit, add and remove as necessary.
* Edit this readme with pertinent info, delete these instructions.
* Finally edit the `.github/workflows/BuildImage.yml`. Customize the build branch, and the vars for `BASEIMAGE` and `MODNAME`.
* Ask the team to create a new branch named `<baseimagename>-<modname>`. Baseimage should be the name of the image the mod will be applied to. The new branch will be based on the `template` branch.
* Submit PR against the branch created by the team.
## Tips and tricks
* To decrease startup times when multiple mods are used, we have consolidated `apt-get update` down to one file. As seen in the [nodejs mod](https://github.com/linuxserver/docker-mods/tree/code-server-nodejs/root/etc/cont-init.d)
* Some images has helpers built in, these images are currently:
* [Openvscode-server](https://github.com/linuxserver/docker-openvscode-server/pull/10/files)
* [Code-server](https://github.com/linuxserver/docker-code-server/pull/95)
If adding multiple mods, enter them in an array separated by `|`,
such as `DOCKER_MODS=linuxserver/mods:universal-calibre|linuxserver/mods:calibre-web-dtrpg-metadata`