Don't chown /data

The LinuxServer.io team brings you another container release featuring:

regular and timely application updates
easy user mappings (PGID, PUID)
custom base image with s6 overlay
weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
regular security updates

Find us at:

Blog - all the things you can do with our containers including How-To guides, opinions and much more!
Discord - realtime support / chat with the community and the team.
Discourse - post on our community forum.
Fleet - an online web interface which displays all of our maintained images.
GitHub - view the source for all of our repositories.
Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/jellyfin

Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/jellyfin:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	❌

Version Tags

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Tag	Available	Description
latest	✅	Stable Jellyfin releases
nightly	✅	Nightly Jellyfin releases

Application Setup

Webui can be found at http://<your-ip>:8096

More information can be found on the official documentation here.

Hardware Acceleration Enhancements

This section lists the enhancements we have made for hardware acceleration in this image specifically.

Intel

To enable the OpenCL based DV, HDR10 and HLG tone-mapping, please refer to the OpenCL-Intel mod from here:

https://mods.linuxserver.io/?mod=jellyfin

OpenMAX (Raspberry Pi)

Hardware acceleration users for Raspberry Pi MMAL/OpenMAX will need to mount their /dev/vcsm and /dev/vchiq video devices inside of the container and their system OpenMax libs by passing the following options when running or creating the container:

--device=/dev/vcsm:/dev/vcsm
--device=/dev/vchiq:/dev/vchiq
-v /opt/vc/lib:/opt/vc/lib

V4L2 (Raspberry Pi)

Hardware acceleration users for Raspberry Pi V4L2 will need to mount their /dev/video1X devices inside of the container by passing the following options when running or creating the container:

--device=/dev/video10:/dev/video10
--device=/dev/video11:/dev/video11
--device=/dev/video12:/dev/video12

Hardware Acceleration

Many desktop applications need access to a GPU to function properly and even some Desktop Environments have compositor effects that will not function without a GPU. However this is not a hard requirement and all base images will function without a video device mounted into the container.

Intel/ATI/AMD

To leverage hardware acceleration you will need to mount /dev/dri video device inside of the container.

--device=/dev/dri:/dev/dri

We will automatically ensure the abc user inside of the container has the proper permissions to access this device.

Nvidia

Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: https://github.com/NVIDIA/nvidia-container-toolkit

We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-container-toolkit is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the container.

Arm Devices

Best effort is made to install tools to allow mounting in /dev/dri on Arm devices. In most cases if /dev/dri exists on the host it should just work. If running a Raspberry Pi 4 be sure to enable dtoverlay=vc4-fkms-v3d in your usercfg.txt.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)

---
services:
  jellyfin:
    image: lscr.io/linuxserver/jellyfin:latest
    container_name: jellyfin
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - JELLYFIN_PublishedServerUrl=192.168.0.5 #optional
    volumes:
      - /path/to/library:/config
      - /path/to/tvseries:/data/tvshows
      - /path/to/movies:/data/movies
    ports:
      - 8096:8096
      - 8920:8920 #optional
      - 7359:7359/udp #optional
      - 1900:1900/udp #optional
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=jellyfin \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e JELLYFIN_PublishedServerUrl=192.168.0.5 `#optional` \
  -p 8096:8096 \
  -p 8920:8920 `#optional` \
  -p 7359:7359/udp `#optional` \
  -p 1900:1900/udp `#optional` \
  -v /path/to/library:/config \
  -v /path/to/tvseries:/data/tvshows \
  -v /path/to/movies:/data/movies \
  --restart unless-stopped \
  lscr.io/linuxserver/jellyfin:latest

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Parameter	Function
`-p 8096`	Http webUI.
`-p 8920`	Optional - Https webUI (you need to set up your own certificate).
`-p 7359/udp`	Optional - Allows clients to discover Jellyfin on the local network.
`-p 1900/udp`	Optional - Service discovery used by DNLA and clients.
`-e PUID=1000`	for UserID - see below for explanation
`-e PGID=1000`	for GroupID - see below for explanation
`-e TZ=Etc/UTC`	specify a timezone to use, see this list.
`-e JELLYFIN_PublishedServerUrl=192.168.0.5`	Set the autodiscovery response domain or IP address.
`-v /config`	Jellyfin data storage location. This can grow very large, 50gb+ is likely for a large collection.
`-v /data/tvshows`	Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc.
`-v /data/movies`	Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc.

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

Optional Parameters

The official documentation for ports has additional ports that can provide auto discovery.

Service Discovery (1900/udp) - Since client auto-discover would break if this option were configurable, you cannot change this in the settings at this time. DLNA also uses this port and is required to be in the local subnet.

Client Discovery (7359/udp) - Allows clients to discover Jellyfin on the local network. A broadcast message to this port with "Who is Jellyfin Server?" will get a JSON response that includes the server address, ID, and name.

  -p 7359:7359/udp \
  -p 1900:1900/udp \

The official documentation for environmentals has additional environmentals that can provide additional configurability such as migrating to the native Jellyfin image.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

Shell access whilst the container is running:
```
docker exec -it jellyfin /bin/bash
```
To monitor the logs of the container in realtime:
```
docker logs -f jellyfin
```

Container version number:

docker inspect -f '{{ index .Config.Labels "build_version" }}' jellyfin

Image version number:

docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/jellyfin:latest

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

Update images:

All images:
```
docker-compose pull
```
Single image:
```
docker-compose pull jellyfin
```

Update containers:
- All containers:
```
docker-compose up -d
```
- Single container:
```
docker-compose up -d jellyfin
```
You can also remove the old dangling images:
```
docker image prune
```

Via Docker Run

Update the image:

docker pull lscr.io/linuxserver/jellyfin:latest

Stop the running container:
```
docker stop jellyfin
```
Delete the container:
```
docker rm jellyfin
```
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:
```
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

tip: We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-jellyfin.git
cd docker-jellyfin
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/jellyfin:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

01.05.24: - Increase verbosity of device permissions fixing.
12.02.24: - Use universal hardware acceleration blurb.
12.09.23: - Take ownership of plugin directories.
04.07.23: - Deprecate armhf. As announced here
07.12.22: - Rebase master to Jammy, migrate to s6v3.
11.06.22: - Switch to upstream repo's ffmpeg5 build.
05.01.22: - Specify Intel iHD driver versions to avoid mismatched libva errors.
25.12.21: - Fix video device group perms error message.
10.12.21: - Rework readme, disable template sync.
22.09.21: - Pull only the server, web and ffmpeg packages instead of the wrapper.
23.06.21: - Add log message if device permissions are incorrect. Pin jellyfin dependency versions to prevent upstream apt repo issues. Deprecate the bionic tag.
21.05.21: - Add nvidia.icd file to fix missing tonemapping using Nvidia HW.
20.01.21: - Add Jellyfin Binary Environmentals
20.01.21: - Deprecate UMASK_SET in favor of UMASK in baseimage, see above for more information.
23.11.20: - Rebase to Focal, branch off Bionic.
22.07.20: - Ingest releases from Jellyfin repo.
28.04.20: - Replace MMAL/OMX dependency device /dev/vc-mem with /dev/vcsm as the former was not sufficient for raspbian.
11.04.20: - Enable hw decode (mmal) on Raspberry Pi, update readme instructions, add donation info, create missing default transcodes folder.
11.03.20: - Add Pi V4L2 support, remove optional transcode mapping (location is selected in the gui, defaults to path under /config).
30.01.20: - Add nightly tag.
09.01.20: - Add Pi OpenMax support.
02.10.19: - Improve permission fixing for render & dvb devices.
31.07.19: - Add AMD drivers for vaapi support on x86.
13.06.19: - Add Intel drivers for vaapi support on x86.
07.06.19: - Initial release.

	chown abc:abc \
	/data/*

linuxserver / docker-jellyfin Goto Github PK

docker-jellyfin's Introduction

Supported Architectures

Version Tags

Application Setup

Hardware Acceleration Enhancements

Intel

OpenMAX (Raspberry Pi)

V4L2 (Raspberry Pi)

Hardware Acceleration

Intel/ATI/AMD

Nvidia

Arm Devices

Usage

docker-compose (recommended, click here for more info)

docker cli (click here for more info)

Parameters

Environment variables from files (Docker secrets)

Umask for running applications

Optional Parameters

User / Group Identifiers

Docker Mods

Support Info

Updating Info

Via Docker Compose

Via Docker Run

Image Update Notifications - Diun (Docker Image Update Notifier)

Building locally

Versions

docker-jellyfin's People

Contributors

Stargazers

Watchers

Forkers

docker-jellyfin's Issues

Expected Behavior

Current Behavior

Environment

Command used to create docker container (run/create/compose/screenshot)

Docker logs

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Command used to create docker container (run/create/compose/screenshot)

Docker logs

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Command used to create docker container (run/create/compose/screenshot)

Docker logs

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Command used to create docker container (run/create/compose/screenshot)

Docker logs

Note

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Command used to create docker container (run/create/compose/screenshot)

Docker logs

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Command used to create docker container (run/create/compose/screenshot)

Docker logs

Expected Behavior

Current Behavior

Steps to Reproduce

Environment

Command used to create docker container (run/create/compose/screenshot)

Docker logs

How to reproduce

Expected Behavior

Current Behavior