From 1e4eae4894fa7620a3081ad6f644401731493ba3 Mon Sep 17 00:00:00 2001 From: Khue Doan Date: Thu, 18 Jan 2024 01:37:33 +0700 Subject: [PATCH] docs: add media management instruction --- README.md | 1 + docs/how-to-guides/media-management.md | 63 ++++++++++++++++++++++++++ mkdocs.yml | 1 + 3 files changed, 65 insertions(+) create mode 100644 docs/how-to-guides/media-management.md diff --git a/README.md b/README.md index 5e6d1f08..8b2a707e 100644 --- a/README.md +++ b/README.md @@ -250,6 +250,7 @@ References: - [Pre-commit config from k8s-at-home/flux-cluster-template](https://github.com/k8s-at-home/flux-cluster-template) - [Diátaxis technical documentation framework](https://diataxis.fr) - [Official Terratest examples](https://github.com/gruntwork-io/terratest/tree/master/test) +- [Self-host an automated Jellyfin media streaming stack](https://zerodya.net/self-host-jellyfin-media-streaming-stack) Here is a list of the contributors who have helped to improve this project. Big shout-out to them! diff --git a/docs/how-to-guides/media-management.md b/docs/how-to-guides/media-management.md new file mode 100644 index 00000000..169b593a --- /dev/null +++ b/docs/how-to-guides/media-management.md @@ -0,0 +1,63 @@ +# Media management + +!!! warning + + This is for educational purposes only :wink: Use it at your own risk! + +## Initial setup + +- Jellyfin `https://jellyfin.example.com`: + - Create an `admin` user and save the credentials to your password manager + - Add media libraries: + - Movies at `/media/movies` + - Shows at `/media/shows` +- Radarr `https://radarr.example.com`: + - Authentication method: Forms + - Create an `admin` user and save the credentials to your password manager + - Navigate to Settings -> Download Clients -> Add -> Transmission (you can keep the default address and port) + - Navigate to Settings -> Media Management -> Add Root Folder `/movies` + - Navigate to Settings -> General -> API Key -> copy it for the next steps (or save it to your password manager) +- Sonarr `https://sonarr.example.com`: same as Radarr but use `/shows` for the root folder +- Prowlarr `https://prowlarr.example.com`: + - Authentication method: Forms + - Create an `admin` user and save the credentials to your password manager + - Navigate to Settings -> Apps -> Add: + - Radarr: paste the API key (you can keep the default address and port) + - Sonarr: same as Radarr + - Go back to Indexers -> Add New Indexers +- Jellyseerr `https://jellyseerr.example.com`: + - Sign In + - Use your Jellyfin account + - URL: `https://jellyfin.example.com` + - Email: you can enter anything + - Username: `admin` + - Password: same as Jellyfin + - Configure Media Server + - Enable Movies and Shows + - Configure Services: + - Add Radarr Server: + - Default Server: true + - Name: Radarr + - Hostname: localhost + - Port: use default + - API Key: from previous step + - Click Test + - Quality Profile: choose whatever suits you + - Root folder: `/movies` + - External URL: `https://radarr.example.com` + - Enable Scan: true + - Add Sonarr Server: similar to Radarr + +Optionally, for convenience, you can add a `guest` account without a password in Jellyfin, +allow access to all libraries, and allow that account to manage requests in Jellyseerr. + +## Usage + +Here's a suggested flow: + +- Users using the `guest` account can request media in Jellyseerr +- Admins approve the request (or you can enable auto-approve) +- Wait for the media to be downloaded +- Watch on Jellyfin + +You may need to increase the volume size depending on your usage. diff --git a/mkdocs.yml b/mkdocs.yml index e3c1d2fc..65669576 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -67,6 +67,7 @@ nav: - how-to-guides/run-commands-on-multiple-nodes.md - how-to-guides/single-node-cluster-adjustments.md - how-to-guides/disable-dhcp-proxy-in-dnsmasq.md + - how-to-guides/media-management.md - how-to-guides/updating-documentation.md - Troubleshooting: - how-to-guides/troubleshooting/index.md