# Jellyfin

## Description

[Jellyfin](https://jellyfin.org) is a free, open-source media server. This role deploys the official `jellyfin/jellyfin` container behind the Infinito.Nexus reverse proxy, with Keycloak OIDC (web) and central LDAP authentication provisioned via the Jellyfin auth plugins.

## Overview

Jellyfin stores its metadata in internal SQLite under `/config` - it needs **no external database**. The role persists three named volumes: `/config`, `/cache`, and `/media`. Media libraries are added in-app against `/media`.

## Cosmos

The diagram places Jellyfin in the Infinito.Nexus cosmos: the components it deploys (capabilities), the central services it consumes (dependencies), and its outward reach (federation and bridged external networks).

```mermaid
flowchart LR
    subgraph deps [Dependencies]
        dep_svc_bkp_volume_2_local["svc-bkp-volume-2-local 💻"]
        dep_svc_db_openldap["svc-db-openldap 🐳🐝"]
        dep_svc_net_tor["svc-net-tor 🐳🐝"]
        dep_web_app_dashboard["web-app-dashboard 🐳🐝"]
        dep_web_app_hermes["web-app-hermes 🐳🐝"]
        dep_web_app_keycloak["web-app-keycloak 🐳🐝"]
        dep_web_app_matomo["web-app-matomo 🐳🐝"]
        dep_web_app_openclaw["web-app-openclaw 🐳🐝"]
        dep_web_app_openwebui["web-app-openwebui 🐳🐝"]
        dep_web_app_prometheus["web-app-prometheus 🐳🐝"]
        dep_web_svc_css["web-svc-css 💻"]
        dep_web_svc_logout["web-svc-logout 🐳🐝"]
    end
    subgraph role [web-app-jellyfin 🐳🐝]
        svc_sso["sso"]
        svc_ldap["ldap"]
        svc_logout["logout"]
        svc_dashboard["dashboard"]
        svc_matomo["matomo"]
        svc_css["css"]
        svc_prometheus["prometheus"]
        svc_jellyfin["jellyfin"]
        svc_tor["tor"]
        svc_container_backup["container_backup"]
        svc_jellyfinmcp["jellyfinmcp"]
        svc_openwebui["openwebui"]
        svc_hermes["hermes"]
        svc_openclaw["openclaw"]
        svc_flowise["flowise ❌"]
    end
    dep_svc_bkp_volume_2_local -. "0..1" .-> svc_container_backup
    dep_svc_db_openldap -. "0..1" .-> svc_ldap
    dep_svc_net_tor -. "0..1" .-> svc_tor
    dep_web_app_dashboard -. "0..1" .-> svc_dashboard
    dep_web_app_hermes -. "0..1" .-> svc_hermes
    dep_web_app_keycloak -. "0..1" .-> svc_sso
    dep_web_app_matomo -. "0..1" .-> svc_matomo
    dep_web_app_openclaw -. "0..1" .-> svc_openclaw
    dep_web_app_openwebui -. "0..1" .-> svc_openwebui
    dep_web_app_prometheus -. "0..1" .-> svc_prometheus
    dep_web_svc_css -. "0..1" .-> svc_css
    dep_web_svc_logout -. "0..1" .-> svc_logout
```

Solid `1:1` edges are fixed relationships; dashed `0..1` edges are conditional (enabled only in matching deployments); red `0..0` edges are turned off in this role. Node markers show the role's deploy modes (💻 host, 🐳 compose, 🐝 swarm); ❌ marks a service that is explicitly turned off, and ⚙️ an Ansible role dependency declared in `meta/main.yml`.

## Features

- **Open-source media streaming** - movies, shows, music, live TV from the official Jellyfin server.
- **Keycloak OIDC (web)** - one-click web sign-in via the [`jellyfin-plugin-sso`](https://github.com/9p4/jellyfin-plugin-sso) plugin against the platform Keycloak.
- **Central LDAP (all clients)** - the [`jellyfin-plugin-ldapauth`](https://github.com/jellyfin/jellyfin-plugin-ldapauth) plugin authenticates web AND native apps against the platform OpenLDAP.
- **Break-glass admin** - a local administrator seeded via the first-run wizard (`/Startup`), independent of SSO/LDAP.
- **No external database** - self-contained SQLite under `/config`.

## Quick Setup

### Development

Clone, set up the workstation, and deploy Jellyfin onto the local stack:

```bash
git clone https://github.com/infinito-nexus/core.git
cd core
make onboard
make compose-deploy mode=reinstall apps=web-app-jellyfin full_cycle=false
```

### Production

Run the published image to provision the inventory and deploy Jellyfin to a managed server (the mounted volume persists the inventory):

```bash
APP=web-app-jellyfin
HOST=<your-server>
DOMAIN=<your-domain>
TLS_MODE=self_signed
SSH_PUBLIC_KEY="<your-ssh-public-key>"

docker run --rm -it \
  -v "$PWD/inventories:/etc/infinito.nexus/inventories" \
  -e APP="$APP" -e HOST="$HOST" -e DOMAIN="$DOMAIN" -e TLS_MODE="$TLS_MODE" -e SSH_PUBLIC_KEY="$SSH_PUBLIC_KEY" \
  ghcr.io/infinito-nexus/core/debian bash -c '
    INVENTORY=/etc/infinito.nexus/inventories/production
    infinito administration inventory provision "$INVENTORY" \
      --inventory-file "$INVENTORY/devices.yml" \
      --host "$HOST" \
      --include "$APP" \
      --vars "{\"TLS_MODE\": \"$TLS_MODE\", \"DOMAIN_PRIMARY\": \"$DOMAIN\", \"users\": {\"administrator\": {\"authorized_keys\": [\"$SSH_PUBLIC_KEY\"]}}}" &&
    infinito administration deploy dedicated "$INVENTORY/devices.yml" \
      --password-file "$INVENTORY/.password" \
      --diff -vv'
```

## Authentication & Admin Model

Jellyfin has **no native OIDC/LDAP**; auth is plugin-based with an important client-coverage caveat:

- **LDAP plugin** works on **every client** (web + native Android/iOS/TV/desktop apps).
- **OIDC SSO plugin** is **web-UI only** - native apps cannot use it (they sign in via LDAP/local).

`files/configure-auth.sh` (run on the deploy host) completes the first-run wizard (seeds the break-glass admin), installs both plugins via Jellyfin's own `/Packages` installer, writes the plugin configs, and restarts.

## Further Resources

- [Jellyfin website](https://jellyfin.org)
- [Container installation](https://jellyfin.org/docs/general/installation/container/)
- [LDAP plugin](https://github.com/jellyfin/jellyfin-plugin-ldapauth)
- [SSO/OIDC plugin](https://github.com/9p4/jellyfin-plugin-sso)

## Persona contract opt-outs

The shared `biber` persona journey is opted out via `PERSONA_BIBER_BLOCKED` in `templates/playwright.env.j2`.
A Jellyfin account binds to exactly one authentication provider, so biber's login is owned by the per-addon specs that know which provider is live: `files/playwright/addons/sso-authentication.spec.js` for OIDC and `addons/ldap-authentication.spec.js` for the LDAP-only matrix variant.
The generic persona cannot pick between them and would duplicate or contradict that coverage; `playwright.spec.js` keeps the `guest` scenario and the native administrator login.

## Credits

Implemented by **[Kevin Veen-Birkenbach](https://www.veen.world)**.
Part of the [Infinito.Nexus Project](https://s.infinito.nexus/code) and maintained by [Kevin Veen-Birkenbach](https://www.veen.world).
Licensed under the [Infinito.Nexus Community License (Non-Commercial)](https://s.infinito.nexus/license).
Licensed under the [Infinito.Nexus Community License (Non-Commercial)](https://s.infinito.nexus/license).