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/jellyfin/installation.md
+++ b/homelabbing/docs/software/mediastack/jellyfin/installation.md
@@ -0,0 +1,82 @@
+# Installation
+
+This guide shows you how to install [Jellyfin](https://jellyfin.org/) via Docker Compose. Make sure Docker Engine is already installed on your system.
+
+## Prerequisites
+
+- Docker Engine installed (follow the official guide linked above)  
+- Docker Compose available  
+- Linux host system
+
+---
+
+## 1. Create a project directory
+
+```bash
+mkdir jellyfin
+cd jellyfin
+```
+
+---
+
+## 2. Create `docker-compose.yml`
+
+```yaml
+version: "3"
+services:
+  jellyfin:
+    image: jellyfin/jellyfin
+    container_name: jellyfin
+    user: uid:gid           # replace uid:gid with your actual user ID and group ID
+    network_mode: "host"    # optional: needed for DLNA and certain integrations
+    volumes:
+      - ./config:/config
+      - ./cache:/cache
+      - /path/to/media:/media
+        # Add more media folders if needed
+    restart: unless-stopped
+    environment:
+      - JELLYFIN_PublishedServerUrl=http://your-domain-or-ip
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+```
+
+---
+
+## 3. Start Jellyfin
+
+```bash
+docker compose up -d
+```
+
+---
+
+## 4. Access Jellyfin
+
+Open a browser and navigate to `http://<your-host-ip>:8096` to begin setup via the web UI.
+
+---
+
+## 5. (Optional) Manage updates
+
+When a new version is available:
+
+```bash
+docker compose pull
+docker compose up -d
+```
+
+---
+
+## Notes
+
+- Ensure user ID (`uid`) and group ID (`gid`) match your Linux user to prevent permissions issues.  
+- Host network mode is required for DLNA and some integrations only; you can remove it if not needed.  
+- This setup uses bind-mounted folders (`./config`, `./cache`, `/path/to/media`) for persistent data.
+
+---
+
+## References
+
+- Official Docker installation guide: https://docs.docker.com/engine/install/  
+- Jellyfin Docker Compose instructions
--- a/homelabbing/docs/software/mediastack/jellyfin/introduction.md
+++ b/homelabbing/docs/software/mediastack/jellyfin/introduction.md
@@ -0,0 +1,60 @@
+# Introduction
+
+**Jellyfin** is a free, open-source media server software that lets you collect, manage, and stream your personal media—such as movies, TV shows, music, and photos—across devices. It is a community-driven alternative to proprietary platforms like Plex and Emby.
+
+---
+
+## Key Features
+
+- 🆓 **Completely Free**: No paid licenses, subscriptions, or locked features.
+- 🛡️ **Privacy-Focused**: No telemetry, no third-party tracking.
+- 📺 **Streaming**: Access your media from web browsers, smart TVs, mobile apps, or Kodi.
+- 🧠 **Metadata Management**: Automatic retrieval of posters, fanart, episode guides, and more.
+- 🎚️ **Transcoding**: On-the-fly conversion for devices with limited format support.
+- 🎛️ **Plugin System**: Extend functionality with community-made plugins.
+
+---
+
+## Supported Platforms
+
+- **Server**: Windows, Linux, macOS, Docker, and more
+- **Clients**:
+  - Web browser
+  - Android / iOS apps
+  - Smart TVs (via apps or DLNA)
+  - Kodi (via Jellyfin add-on)
+  - Chromecast
+
+---
+
+## Ideal Use Cases
+
+- Home media streaming over LAN or internet
+- Centralized media hub for a household
+- Replacement for paid services (e.g., Plex, Netflix for local content)
+
+---
+
+## Comparison to Plex & Emby
+
+| Feature            | Jellyfin        | Plex            | Emby            |
+|--------------------|-----------------|------------------|------------------|
+| Open Source        | ✅ Yes          | ❌ No            | ⚠️ Partial        |
+| Free Features      | ✅ All          | ❌ Some Locked   | ⚠️ Limited        |
+| No Account Needed  | ✅ Yes          | ❌ No            | ⚠️ Mostly         |
+| Community-Driven   | ✅ 100%         | ❌               | ⚠️ Limited        |
+
+---
+
+## Quick Start
+
+If you haven’t installed Jellyfin yet, check the [Docker Compose installation guide](./jellyfin-docker-compose.md) or visit the [official documentation](https://jellyfin.org/docs/).
+
+---
+
+## Links
+
+- 🌐 Website: https://jellyfin.org  
+- 📘 Docs: https://jellyfin.org/docs/  
+- 🐙 GitHub: https://github.com/jellyfin/jellyfin  
+- 💬 Community: https://matrix.to/#/#jellyfin:matrix.org