Dark-Alex-17
f3ad44f7d7
Adds darkalex17/readarr-mock, built from ghcr.io/pennydreadful/bookshelf:softcover (the maintained Readarr continuation; the LinuxServer image is discontinued and its metadata endpoint no longer resolves). The captured config carries 6 authors, 327 books, 39 book files, 4 tags, 7 indexers, 193 history rows and one root folder at /books, with minimal EPUBs under mock-htpc/books so the files show as imported. Prowlarr now registers Readarr as a synced application, so its config is recaptured and the prowlarr-mock image must be rebuilt and pushed alongside. The compose file, managarr config, justfile recipes and README gain the fourth instance. The demo script needs no change; it fetches the compose file and config from main at run time. Requires a Managarr release with Readarr support, since the demo script runs the published darkalex17/managarr image against these files.
2.6 KiB
Managarr Demo
A demo repository with a basic HTPC configuration for demonstration and testing purposes with Managarr.
One-Command Run
To clone the repo and run the demo all in one go, the following command will download the managarr-demo script and run it:
curl https://raw.githubusercontent.com/Dark-Alex-17/managarr-demo/main/managarr-demo.sh > /tmp/managarr-demo.sh && bash /tmp/managarr-demo.sh
Note: This script will only work on systems with bash installed.
Running the demo
To run this demo, simply run the demo script:
./managarr-demo.sh
Limitations
This demo has no download functionality. It is an eventual goal to have a mock API for one of the BitTorrent clients like Transmission to emulate this functionality for a full demo experience.
Building
This repo uses just to manage build tasks.
To build any individual mock Servarr docker image or even all of them, you can use the build recipes in the justfile:
$ just --list
Available recipes:
...
[build]
build-all # Build all mock container images
build-lidarr # Build the Lidarr mock image
build-prowlarr # Build the Prowlarr mock image
build-radarr # Build the Radarr mock image
build-readarr # Build the Readarr mock image
build-sonarr # Build the Sonarr mock image
...
Pushing
This repo uses just to manage push tasks.
To push any individual mock Servarr docker image or even all of them, you can use the push recipes in the justfile:
$ just --list
Available recipes:
...
[push]
push-all # Push all mock container images
push-lidarr # Push the Lidarr mock image
push-prowlarr # Push the Prowlarr mock image
push-radarr # Push the Radarr mock image
push-readarr # Push the Readarr mock image
push-sonarr # Push the Sonarr mock image
...
Running directly with docker compose
If you wish to run the demo directly from the docker-compose.yml, you can either run it simply with
docker compose run --rm managarr
which will use the default managarr configuration file, or you can specify it manually with the MANAGARR_CONFIG environment variable:
MANAGARR_CONFIG=/tmp/managarr.yml docker compose run --rm managarr