Jellyfin: Difference between revisions

(6 intermediate revisions by 6 users not shown)

Line 1:

Jellyfin is the volunteer-built media solution that puts you in control of your media. Stream to any device from your own server, with no strings attached.

== ~~Installing & Initial Configuration & Setup~~ ==

== Installation and configuration ==

To get up and running with Jellyfin, add the packages <code>pkgs.jellyfin</code> <code>pkgs.jellyfin-web</code> & <code>pkgs.jellyfin-ffmpeg</code> to your `configuration.nix` file as shown below.

Line 27:

</syntaxHighlight>

Once you have included the ~~correct~~ packages to be installed, and enabled and configured Jellyfin to your liking, then rebuild your system for changes to take effect.

Once you have included the packages to be installed, and enabled and configured Jellyfin to your liking, then rebuild your system for changes to take effect.

<syntaxHighlight lang=bash>$ sudo nixos-rebuild switch</syntaxHighlight>

After the rebuild is complete Jellyfin should be running~~, verify~~ that it is with the following command.

After the rebuild is complete, Jellyfin should be running. Verify that it is with the following command.

<syntaxHighlight lang=bash>$ sudo systemctl status jellyfin</syntaxHighlight>

~~<b>~~If jellyfin is not running~~</b>~~ you should be able to start it by ~~simply~~ running <code>jellyfin</code> in your terminal.

If jellyfin is not running you should be able to start it by running <code>jellyfin</code> in your terminal.

<syntaxHighlight lang=bash>$ jellyfin</syntaxHighlight>

~~Finally.~~ After you've verified that Jellyfin is running you can start the configuration process.

After you've verified that Jellyfin is running you can start the configuration process.

* The Jellyfin server should be running on port 8096.

* Go to http://localhost:8096 if ~~your~~ setting this up on your primary computer or want to test your build locally.

* Go to http://localhost:8096 if you are setting this up on your primary computer or want to test your build locally.

* If you're logging into a remote server, replace localhost with the ip address of the server.

=== Allow Jellyfin to read external drives ===

You might encounter permission issues when you try to access external drives if you haven't configured anything else with the server yet. If you haven't explicitly set up a mounting configuration for your drives and instead ~~have~~ your desktop environment (e.g. GNOME or KDE) automatically mount it when you try accessing it via their file explorers, Jellyfin won't be able to access the drive. This is because the desktop environment mounts it to your user, while Jellyfin ~~uses~~ by default the "jellyfin" user.

You might encounter permission issues when you try to access external drives if you haven't configured anything else with the server yet. If you haven't explicitly set up a mounting configuration for your drives and instead let your desktop environment (e.g. GNOME or KDE) automatically mount it when you try accessing it via their file explorers, Jellyfin won't be able to access the drive. This is because the desktop environment mounts it to your user, while Jellyfin runs by default as the "jellyfin" user.

The easiest way to allow it to see these external drives ~~mounted~~ is to change the service's user . Here is an example:

The easiest way to allow it to see these external drives is to change the service's user . Here is an example:

services.jellyfin = {

Line 54:

</syntaxhighlight>

If you have changed the user option after you have already installed Jellyfin, you have to change the ~~permissions~~ of the folder /var/lib/jellyfin ~~via chown~~ to the user you set it to by doing this:

If you have changed the user option after you have already installed Jellyfin, you have to change the ownership of the folder `/var/lib/jellyfin` to the user you set it to by doing this:

sudo chown -R /var/lib/jellyfin

sudo chown -R yourusername:yourusername /var/lib/jellyfin

</syntaxhighlight>

Additionally, you should also change the ownership of the cache directory to avoid transcoding issues:

sudo chown -R yourusername:yourusername /var/cache/jellyfin

</syntaxhighlight>

Finally, restart Jellyfin for the changes to take effect:

systemctl restart jellyfin

</syntaxhighlight>

The alternative ~~to this~~ is to explicitly mount the drives via [[Filesystems]]~~, but~~ takes more effort to set up and requires every new drive ~~you want plex to see~~ to be explicitly declared, but allows more control in what ~~Plex~~ is allowed to see.

The alternative is to explicitly mount the drives via [[Filesystems]]. This takes more effort to set up and requires every new drive to be explicitly declared, but allows more control in what Jellyfin is allowed to see.

=== Intro Skipper plugin ===

If you install ~~intro skipper~~ plugin, it will not be able to display skip button in web interface. This is due to the plugin being unable to modify contents of files in nix store. To get around this you can make the changes yourself with this:

If you install the Intro Skipper plugin, it will not be able to display the skip button in the web interface. This is due to the plugin being unable to modify contents of files in the nix store. To get around this you can make the changes yourself with this:

nixpkgs.overlays = with pkgs; [

Line 87:

Line 100:

</syntaxhighlight>

== Hardware ~~Transcoding~~ ==

== Hardware transcoding ==

In most cases you want to make most of your hardware. Modern boards often come with ~~Hardware Accelerators~~, all you need to do is enable it!

In most cases you want to make most of your hardware. Modern boards often come with a hardware accelerator, all you need to do is enable it!

Source: https://jellyfin.org/docs/general/administration/hardware-acceleration.html

Line 96:

Line 109:

VAAPI and QSV is often available on platforms with Intel GPUs but need their corresponding packages in <code>hardware.graphics.extraPackages</code>.

<~~syntaxHighlight~~ lang=nix>

{ pkgs, lib,config, ... }:

{

Line 103:

Line 116:

vaapiIntel = pkgs.vaapiIntel.override { enableHybridCodec = true; };

};

hardware.graphics = { ~~# hardware.opengl in 24.05~~

hardware.graphics = {

enable = true;

extraPackages = with pkgs; [

intel-media-driver

intel-vaapi-driver ~~# previously vaapiIntel~~

intel-vaapi-driver

vaapiVdpau

~~libvdpau-va-gl~~

intel-compute-runtime # OpenCL filter support (hardware tonemapping and subtitle burn-in)

# OpenCL support for intel CPUs before 12th gen

# see: https://github.com/NixOS/nixpkgs/issues/356535

intel-compute-runtime-legacy1

vpl-gpu-rt # QSV on 11th gen or newer

intel-media-sdk # QSV up to 11th gen

Line 119:

Line 134:

services.jellyfin.enable = true;

}

</~~syntaxHighlight~~>

</syntaxhighlight>

If you want to use an Arc GPU for transcoding, you may need to override the ffmpeg version used by jellyfin to ensure that it is compiled with <code>vpl</code> and, potentially, <code>unfree</code>. An example to achieve this through [[Overlays|an overlay]]:<syntaxhighlight lang="nix">

{ pkgs, ... }:

let

jellyfin-ffmpeg-overlay = (

_ prev: {

jellyfin-ffmpeg = prev.jellyfin-ffmpeg.override {

# Exact version of ffmpeg_* depends on what jellyfin-ffmpeg package is using.

# In 24.11 it's ffmpeg_7-full.

# See jellyfin-ffmpeg package source for details

ffmpeg_7-full = prev.ffmpeg_7-full.override {

withMfx = false; # This corresponds to the older media driver

withVpl = true; # This is the new driver

withUnfree = true;

};

}

);

in

{

nixpkgs.overlays = [ jellyfin-ffmpeg-overlay ];

}

</syntaxhighlight>This will trigger a rebuild of Jellyfin package, but the end result is that if you select "Intel QuickSync (QSV)" you should see little to no CPU load when transcoding.

Note that if your system has an integrated GPU (one built into the CPU) and a discrete GPU, you may need to select the QSV device in the "Playback" settings. Otherwise the device may be picked at random and produce random results. You can use <code>intel_gpu_top -L</code> to identify the devices.

Related: [[~~Accelerated_Video_Playback~~]] [[~~Intel_Graphics~~]]

Related: [[Accelerated Video Playback]] and [[Intel Graphics]]

[[Category:Server]]

[[Category:Applications]]

@@ Line 1: / Line 1: @@
 Jellyfin is the volunteer-built media solution that puts you in control of your media. Stream to any device from your own server, with no strings attached.
-== Installing & Initial Configuration & Setup ==
+== Installation and configuration ==
 To get up and running with Jellyfin, add the packages <code>pkgs.jellyfin</code> <code>pkgs.jellyfin-web</code> & <code>pkgs.jellyfin-ffmpeg</code> to your `configuration.nix` file as shown below.
@@ Line 27: / Line 27: @@
 </syntaxHighlight>
-Once you have included the correct packages to be installed, and enabled and configured Jellyfin to your liking, then rebuild your system for changes to take effect.
+Once you have included the packages to be installed, and enabled and configured Jellyfin to your liking, then rebuild your system for changes to take effect.
 <syntaxHighlight lang=bash>$ sudo nixos-rebuild switch</syntaxHighlight>
-After the rebuild is complete Jellyfin should be running, verify that it is with the following command.
+After the rebuild is complete, Jellyfin should be running. Verify that it is with the following command.
 <syntaxHighlight lang=bash>$ sudo systemctl status jellyfin</syntaxHighlight>
-<b>If jellyfin is not running</b> you should be able to start it by simply running <code>jellyfin</code> in your terminal.
+If jellyfin is not running you should be able to start it by running <code>jellyfin</code> in your terminal.
 <syntaxHighlight lang=bash>$ jellyfin</syntaxHighlight>
-Finally. After you've verified that Jellyfin is running you can start the configuration process.
+After you've verified that Jellyfin is running you can start the configuration process.
 * The Jellyfin server should be running on port 8096.
-* Go to http://localhost:8096 if your setting this up on your primary computer or want to test your build locally.
+* Go to http://localhost:8096 if you are setting this up on your primary computer or want to test your build locally.
 * If you're logging into a remote server, replace localhost with the ip address of the server.
 === Allow Jellyfin to read external drives ===
-You might encounter permission issues when you try to access external drives if you haven't configured anything else with the server yet. If you haven't explicitly set up a mounting configuration for your drives and instead have your desktop environment (e.g. GNOME or KDE) automatically mount it when you try accessing it via their file explorers, Jellyfin won't be able to access the drive. This is because the desktop environment mounts it to your user, while Jellyfin uses by default the "jellyfin" user.
+You might encounter permission issues when you try to access external drives if you haven't configured anything else with the server yet. If you haven't explicitly set up a mounting configuration for your drives and instead let your desktop environment (e.g. GNOME or KDE) automatically mount it when you try accessing it via their file explorers, Jellyfin won't be able to access the drive. This is because the desktop environment mounts it to your user, while Jellyfin runs by default as the "jellyfin" user.
-The easiest way to allow it to see these external drives mounted is to change the service's user . Here is an example:
+The easiest way to allow it to see these external drives is to change the service's user . Here is an example:
 <syntaxhighlight lang="nix">
    services.jellyfin = {
@@ Line 54: / Line 54: @@
 </syntaxhighlight>
-If you have changed the user option after you have already installed Jellyfin, you have to change the permissions of the folder /var/lib/jellyfin via chown to the user you set it to by doing this:
+If you have changed the user option after you have already installed Jellyfin, you have to change the ownership of the folder `/var/lib/jellyfin` to the user you set it to by doing this:
-<syntaxhighlight lang="nix">
-   sudo chown -R /var/lib/jellyfin
+<syntaxhighlight lang="bash">
+   sudo chown -R yourusername:yourusername /var/lib/jellyfin
+</syntaxhighlight>
+Additionally, you should also change the ownership of the cache directory to avoid transcoding issues:
+<syntaxhighlight lang="bash">
+  sudo chown -R yourusername:yourusername /var/cache/jellyfin
+</syntaxhighlight>
+Finally, restart Jellyfin for the changes to take effect:
+<syntaxhighlight lang="bash">
+  systemctl restart jellyfin
 </syntaxhighlight>
-The alternative to this is to explicitly mount the drives via [[Filesystems]], but takes more effort to set up and requires every new drive you want plex to see to be explicitly declared, but allows more control in what Plex is allowed to see.
+The alternative is to explicitly mount the drives via [[Filesystems]]. This takes more effort to set up and requires every new drive to be explicitly declared, but allows more control in what Jellyfin is allowed to see.
 === Intro Skipper plugin ===
-If you install intro skipper plugin, it will not be able to display skip button in web interface. This is due to the plugin being unable to modify contents of files in nix store. To get around this you can make the changes yourself with this:
+If you install the Intro Skipper plugin, it will not be able to display the skip button in the web interface. This is due to the plugin being unable to modify contents of files in the nix store. To get around this you can make the changes yourself with this:
 <syntaxhighlight lang="nix">
    nixpkgs.overlays = with pkgs; [
@@ Line 87: / Line 100: @@
 </syntaxhighlight>
-== Hardware Transcoding ==
+== Hardware transcoding ==
-In most cases you want to make most of your hardware. Modern boards often come with Hardware Accelerators, all you need to do is enable it!
+In most cases you want to make most of your hardware. Modern boards often come with a hardware accelerator, all you need to do is enable it!
 Source: https://jellyfin.org/docs/general/administration/hardware-acceleration.html
@@ Line 96: / Line 109: @@
 VAAPI and QSV is often available on platforms with Intel GPUs but need their corresponding packages in <code>hardware.graphics.extraPackages</code>.
-<syntaxHighlight lang=nix>
+<syntaxhighlight lang="nix">
 { pkgs, lib,config, ... }:
 {
@@ Line 103: / Line 116: @@
      vaapiIntel = pkgs.vaapiIntel.override { enableHybridCodec = true; };
    };
-   hardware.graphics = { # hardware.opengl in 24.05
+   hardware.graphics = {
      enable = true;
      extraPackages = with pkgs; [
        intel-media-driver
-       intel-vaapi-driver # previously vaapiIntel
+       intel-vaapi-driver
        vaapiVdpau
-      libvdpau-va-gl
        intel-compute-runtime # OpenCL filter support (hardware tonemapping and subtitle burn-in)
+      # OpenCL support for intel CPUs before 12th gen
+      # see: https://github.com/NixOS/nixpkgs/issues/356535
+      intel-compute-runtime-legacy1
        vpl-gpu-rt # QSV on 11th gen or newer
        intel-media-sdk # QSV up to 11th gen
@@ Line 119: / Line 134: @@
    services.jellyfin.enable = true;
 }
-</syntaxHighlight>
+</syntaxhighlight>
+If you want to use an Arc GPU for transcoding, you may need to override the ffmpeg version used by jellyfin to ensure that it is compiled with <code>vpl</code> and, potentially, <code>unfree</code>. An example to achieve this through [[Overlays|an overlay]]:<syntaxhighlight lang="nix">
+{ pkgs, ... }:
+let
+  jellyfin-ffmpeg-overlay = (
+    _ prev: {
+      jellyfin-ffmpeg = prev.jellyfin-ffmpeg.override {
+        # Exact version of ffmpeg_* depends on what jellyfin-ffmpeg package is using.
+        # In 24.11 it's ffmpeg_7-full.
+        # See jellyfin-ffmpeg package source for details
+        ffmpeg_7-full = prev.ffmpeg_7-full.override {
+          withMfx = false; # This corresponds to the older media driver
+          withVpl = true; # This is the new driver
+          withUnfree = true;
+        };
+      };
+    }
+  );
+in
+{
+  nixpkgs.overlays = [ jellyfin-ffmpeg-overlay ];
+}
+</syntaxhighlight>This will trigger a rebuild of Jellyfin package, but the end result is that if you select "Intel QuickSync (QSV)" you should see little to no CPU load when transcoding.
+Note that if your system has an integrated GPU (one built into the CPU) and a discrete GPU, you may need to select the QSV device in the "Playback" settings. Otherwise the device may be picked at random and produce random results. You can use <code>intel_gpu_top -L</code> to identify the devices.
-Related:  [[Accelerated_Video_Playback]] [[Intel_Graphics]]
+Related:  [[Accelerated Video Playback]] and [[Intel Graphics]]
 [[Category:Server]]
 [[Category:Applications]]