basic structure

2025-08-04 23:11:16 +02:00
parent 794f63358e
commit 41adec1bf7
34 changed files with 717 additions and 569 deletions
--- a/homelabbing/docs/software/mediastack/introduction.md
+++ b/homelabbing/docs/software/mediastack/introduction.md
@@ -0,0 +1,101 @@
+# Introduction
+
+This documentation describes a self-hosted, Docker-based media automation stack that handles everything from user requests to content playback, fully integrated with Jellyfin as the central media server.
+
+The stack includes download automation (Usenet), metadata scraping, transcoding, user interface for media requests, monitoring, and search. Everything is containerized and orchestrated with Docker Compose.
+
+---
+
+## 1. Prerequisites
+
+Before continuing, make sure Docker and Docker Compose are installed on your system.  
+You can follow the installation guide here:  
+👉 [Install Docker on Debian/Ubuntu](../../knowhow/docker/)
+
+---
+
+## 2. Stack Overview
+
+The following diagram illustrates how the various components in the media stack interact:
+
+![Media Stack Architecture](../img/mediastack-diagram.png)
+
+**Legend / Component Highlights:**
+
+- **Jellyfin**: the main media server for playback and library management
+- **Jellyseerr**: user-facing request portal
+- **Radarr/Sonarr**: automation for movies and series
+- **Prowlarr**: indexer aggregator for both Radarr and Sonarr
+- **SABnzbd**: Usenet downloader
+- **Tdarr**: automated transcoding engine
+- **Meilisearch**: search backend for metadata (used by Scraparr/Suggestarr)
+- **Wizarr**: user invite and account management
+- **Trailarr & Huntarr**: UI enhancements and support tooling
+- **Scraparr & Suggestarr**: metadata and suggestion automation
+
+---
+
+## 3. Directory Structure
+
+Your directory tree is organized to clearly separate persistent data and component configuration:
+
+```
+/mediastack
+├── 4k-radarr               # Radarr instance for 4K content
+├── jellyfin                # Config/data for Jellyfin
+├── jellyseerr              # Request frontend
+├── radarr                  # Main movie automation
+├── sonarr                  # Series automation
+├── sabnzbd                 # Usenet download client
+├── tdarr                   # Transcoding
+├── prowlarr                # Indexer management
+├── wizarr                  # Invite portal
+├── postgres                # Database service
+├── huntarr, trailarr*      # Visual/UX enhancements
+├── scraparr, suggestarr    # Metadata and recommendation tooling
+├── cache/
+│   ├── jellyfin
+│   ├── sabnzbd
+│   ├── tdarr
+│   └── meilisearch
+├── media/
+│   ├── 4k-filme
+│   ├── anime_filme
+│   ├── animes
+│   ├── filme
+│   ├── serien
+│   └── posters
+```
+
+> All services are managed using Docker Compose with volume mounts mapped into the above directories.
+
+---
+
+## 4. Benefits
+
+- 🧩 Modular: You can scale or swap components easily
+- 🐳 Containerized: Consistent and portable deployments
+- 🧠 Automated: Minimal manual work once configured
+- 📦 Composable: All services communicate via APIs or shared volumes
+- 🔐 Local-first & private
+
+---
+
+## 5. Next Steps
+
+- Set up Docker and Docker Compose if you haven't yet
+- Start configuring the services one by one (see individual `.md` files)
+- Secure access via reverse proxy (e.g., Traefik or Nginx)
+- Enjoy your fully automated media center 🎬
+
+---
+
+## Links
+
+- Jellyfin: https://jellyfin.org  
+- Jellyseerr: https://github.com/Fallenbagel/jellyseerr  
+- Tdarr: https://github.com/HaveAGitGat/Tdarr  
+- SABnzbd: https://sabnzbd.org  
+- Radarr: https://radarr.video  
+- Sonarr: https://sonarr.tv  
+- Prowlarr: https://github.com/Prowlarr/Prowlarr