From 0fdb9e2ac359d03d1053bccbd7687d8a8742fce0 Mon Sep 17 00:00:00 2001 From: Sleeps Date: Wed, 7 Oct 2026 11:02:00 +0100 Subject: [PATCH] Document deployment helper scripts --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/README.md b/README.md index 1872115..ab5120b 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,61 @@ If `SCENE_API_KEY` is configured, enter it once in the dashboard. It is stored o > If an item has no Jellyfin Trickplay data and the indexer must use ffmpeg fallback, its Jellyfin media path must also be mounted into the container at the same path. Trickplay-backed items do not require the original media filesystem to be mounted. +## Deployment helper scripts + +Common deployment/admin jobs are wrapped in executable scripts: + +```bash +# Build the Jellyfin plugin DLL, install it, fix ownership and restart Jellyfin. +# If dotnet is not installed locally, this automatically builds with the +# official .NET 10 SDK Docker image. +./scripts/plugin-rebuild.sh + +# Rebuild/start the Docker stack (Scene Search + Meilisearch). +./scripts/docker-rebuild.sh + +# Restart only the Scene Search container without rebuilding it. +./scripts/docker-restart.sh + +# Follow the Scene Search container log. +./scripts/logs.sh + +# Show Docker, Jellyfin, API health and GPU status. +./scripts/status.sh + +# After merging changes: pull, build the DLL, rebuild Docker, deploy the +# plugin, restart Jellyfin and show final status. +./scripts/update-all.sh +``` + +If you already ran `git pull` yourself: + +```bash +./scripts/update-all.sh --no-pull +``` + +Useful partial update options: + +```bash +./scripts/update-all.sh --skip-plugin +./scripts/update-all.sh --skip-docker + +# Build the plugin without installing it: +./scripts/plugin-rebuild.sh --build-only + +# Install an already-built DLL: +./scripts/plugin-rebuild.sh --install-only + +# Install it without restarting Jellyfin: +./scripts/plugin-rebuild.sh --install-only --no-restart +``` + +The default plugin destination is `/var/lib/jellyfin/plugins/SceneSearch`. Override it when needed: + +```bash +JELLYFIN_PLUGIN_DIR=/some/other/path ./scripts/plugin-rebuild.sh +``` + ## 2. Python environment Create and activate a venv, install a CUDA-compatible PyTorch build if required, then: