Skip to content

Commit 4fae811

Browse files
aptalcaaptalca
committed
increase verbosity of init-video, readme updates
1 parent e86fabc commit 4fae811

File tree

4 files changed

+138
-87
lines changed

4 files changed

+138
-87
lines changed

‎Jenkinsfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,7 @@ pipeline {
521521
--label \"org.opencontainers.image.licenses=GPL-3.0-only\" \
522522
--label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \
523523
--label \"org.opencontainers.image.title=Jellyfin\" \
524-
--label \"org.opencontainers.image.description=[Jellyfin](https://jellyfin.github.io/) 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.\" \
524+
--label \"org.opencontainers.image.description=[Jellyfin](https://github.com/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.\" \
525525
--no-cache --pull -t ${IMAGE}:${META_TAG} --platform=linux/amd64 \
526526
--build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
527527
}
@@ -552,7 +552,7 @@ pipeline {
552552
--label \"org.opencontainers.image.licenses=GPL-3.0-only\" \
553553
--label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \
554554
--label \"org.opencontainers.image.title=Jellyfin\" \
555-
--label \"org.opencontainers.image.description=[Jellyfin](https://jellyfin.github.io/) 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.\" \
555+
--label \"org.opencontainers.image.description=[Jellyfin](https://github.com/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.\" \
556556
--no-cache --pull -t ${IMAGE}:amd64-${META_TAG} --platform=linux/amd64 \
557557
--build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
558558
}
@@ -580,7 +580,7 @@ pipeline {
580580
--label \"org.opencontainers.image.licenses=GPL-3.0-only\" \
581581
--label \"org.opencontainers.image.ref.name=${COMMIT_SHA}\" \
582582
--label \"org.opencontainers.image.title=Jellyfin\" \
583-
--label \"org.opencontainers.image.description=[Jellyfin](https://jellyfin.github.io/) 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.\" \
583+
--label \"org.opencontainers.image.description=[Jellyfin](https://github.com/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.\" \
584584
--no-cache --pull -f Dockerfile.aarch64 -t ${IMAGE}:arm64v8-${META_TAG} --platform=linux/arm64 \
585585
--build-arg ${BUILD_VERSION_ARG}=${EXT_RELEASE} --build-arg VERSION=\"${VERSION_TAG}\" --build-arg BUILD_DATE=${GITHUB_DATE} ."
586586
sh "docker tag ${IMAGE}:arm64v8-${META_TAG} ghcr.io/linuxserver/lsiodev-buildcache:arm64v8-${COMMIT_SHA}-${BUILD_NUMBER}"

‎README.md

Lines changed: 67 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ Find us at:
3939
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-jellyfin%2Fjob%2Fnightly%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-jellyfin/job/nightly/)
4040
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fjellyfin%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/jellyfin/latest/index.html)
4141

42-
[Jellyfin](https://jellyfin.github.io/) 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.
42+
[Jellyfin](https://github.com/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.
4343

44-
[![jellyfin](https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true)](https://jellyfin.github.io/)
44+
[![jellyfin](https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true)](https://github.com/jellyfin/jellyfin)
4545

4646
## Supported Architectures
4747

@@ -64,51 +64,70 @@ This image provides various versions that are available via tags. Please read th
6464
| Tag | Available | Description |
6565
| :----: | :----: |--- |
6666
| latest | ✅ | Stable Jellyfin releases |
67-
| nightly | ✅ | Unstable Jellyfin releases |
67+
| nightly | ✅ | Nightly Jellyfin releases |
6868

6969
## Application Setup
7070

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

73-
More information can be found in their official documentation [here](https://jellyfin.org/docs/general/quick-start.html) .
73+
More information can be found on the official documentation [here](https://jellyfin.org/docs/general/quick-start.html).
7474

75-
## Hardware Acceleration
75+
### Hardware Acceleration Enhancements
7676

77-
### Intel
78-
79-
Hardware acceleration users for Intel Quicksync will need to mount their /dev/dri video device inside of the container by passing the following command when running or creating the container:
80-
81-
```--device=/dev/dri:/dev/dri```
82-
83-
We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
77+
This section lists the enhancements we have made for hardware acceleration in this image specifically.
8478

85-
### Nvidia
79+
### Intel
8680

87-
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:
81+
To enable the OpenCL based DV, HDR10 and HLG tone-mapping, please refer to the OpenCL-Intel mod from here:
8882

89-
https://github.com/NVIDIA/nvidia-docker
83+
https://mods.linuxserver.io/?mod=jellyfin
9084

91-
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker 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 jellyfin docker container.
9285

93-
### MMAL/OpenMAX (Raspberry Pi)
86+
#### OpenMAX (Raspberry Pi)
9487

95-
Hardware acceleration users for Raspberry Pi MMAL/OpenMAX will need to mount their `/dev/vc-mem` 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:
88+
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:
9689

9790
```
98-
--device=/dev/vc-mem:/dev/vc-mem
91+
--device=/dev/vcsm:/dev/vcsm
9992
--device=/dev/vchiq:/dev/vchiq
10093
-v /opt/vc/lib:/opt/vc/lib
10194
```
10295

103-
### V4L2 (Raspberry Pi)
96+
#### V4L2 (Raspberry Pi)
10497

10598
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:
99+
106100
```
107101
--device=/dev/video10:/dev/video10
108102
--device=/dev/video11:/dev/video11
109103
--device=/dev/video12:/dev/video12
110104
```
111105

106+
### Hardware Acceleration
107+
108+
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.
109+
110+
#### Intel/ATI/AMD
111+
112+
To leverage hardware acceleration you will need to mount /dev/dri video device inside of the container.
113+
114+
```text
115+
--device=/dev/dri:/dev/dri
116+
```
117+
118+
We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
119+
120+
#### Nvidia
121+
122+
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:
123+
https://github.com/NVIDIA/nvidia-container-toolkit
124+
125+
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.
126+
127+
#### Arm Devices
128+
129+
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.
130+
112131
## Usage
113132

114133
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
@@ -125,21 +144,16 @@ services:
125144
- PUID=1000
126145
- PGID=1000
127146
- TZ=Etc/UTC
147+
- JELLYFIN_PublishedServerUrl=192.168.0.5 #optional
128148
volumes:
129149
- /path/to/library:/config
130-
- path/to/tvseries:/data/tvshows
150+
- /path/to/tvseries:/data/tvshows
131151
- /path/to/movies:/data/movies
132-
- /opt/vc/lib:/opt/vc/lib #optional
133152
ports:
134153
- 8096:8096
135154
- 8920:8920 #optional
136-
devices:
137-
- /dev/dri:/dev/dri #optional
138-
- /dev/vc-mem:/dev/vc-mem #optional
139-
- /dev/vchiq:/dev/vchiq #optional
140-
- /dev/video10:/dev/video10 #optional
141-
- /dev/video11:/dev/video11 #optional
142-
- /dev/video12:/dev/video12 #optional
155+
- 7359:7359/udp #optional
156+
- 1900:1900/udp #optional
143157
restart: unless-stopped
144158
```
145159
@@ -151,18 +165,14 @@ docker run -d \
151165
-e PUID=1000 \
152166
-e PGID=1000 \
153167
-e TZ=Etc/UTC \
168+
-e JELLYFIN_PublishedServerUrl=192.168.0.5 `#optional` \
154169
-p 8096:8096 \
155170
-p 8920:8920 `#optional` \
171+
-p 7359:7359/udp `#optional` \
172+
-p 1900:1900/udp `#optional` \
156173
-v /path/to/library:/config \
157-
-v path/to/tvseries:/data/tvshows \
174+
-v /path/to/tvseries:/data/tvshows \
158175
-v /path/to/movies:/data/movies \
159-
-v /opt/vc/lib:/opt/vc/lib `#optional` \
160-
--device /dev/dri:/dev/dri `#optional` \
161-
--device /dev/vc-mem:/dev/vc-mem `#optional` \
162-
--device /dev/vchiq:/dev/vchiq `#optional` \
163-
--device /dev/video10:/dev/video10 `#optional` \
164-
--device /dev/video11:/dev/video11 `#optional` \
165-
--device /dev/video12:/dev/video12 `#optional` \
166176
--restart unless-stopped \
167177
lscr.io/linuxserver/jellyfin:nightly
168178
```
@@ -174,20 +184,16 @@ Containers are configured using parameters passed at runtime (such as those abov
174184
| Parameter | Function |
175185
| :----: | --- |
176186
| `-p 8096` | Http webUI. |
177-
| `-p 8920` | Https webUI (you need to set up your own certificate). |
187+
| `-p 8920` | Optional - Https webUI (you need to set up your own certificate). |
188+
| `-p 7359/udp` | Optional - Allows clients to discover Jellyfin on the local network. |
189+
| `-p 1900/udp` | Optional - Service discovery used by DNLA and clients. |
178190
| `-e PUID=1000` | for UserID - see below for explanation |
179191
| `-e PGID=1000` | for GroupID - see below for explanation |
180192
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
193+
| `-e JELLYFIN_PublishedServerUrl=192.168.0.5` | Set the autodiscovery response domain or IP address. |
181194
| `-v /config` | Jellyfin data storage location. *This can grow very large, 50gb+ is likely for a large collection.* |
182195
| `-v /data/tvshows` | Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc. |
183196
| `-v /data/movies` | Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc. |
184-
| `-v /opt/vc/lib` | Path for Raspberry Pi OpenMAX libs *optional*. |
185-
| `--device /dev/dri` | Only needed if you want to use your Intel GPU for hardware accelerated video encoding (vaapi). |
186-
| `--device /dev/vc-mem` | Only needed if you want to use your Raspberry Pi MMAL video decoding (Enabled as OpenMax H264 decode in gui settings). |
187-
| `--device /dev/vchiq` | Only needed if you want to use your Raspberry Pi OpenMax video encoding (Bellagio). |
188-
| `--device /dev/video10` | Only needed if you want to use your Raspberry Pi V4L2 video encoding. |
189-
| `--device /dev/video11` | Only needed if you want to use your Raspberry Pi V4L2 video encoding. |
190-
| `--device /dev/video12` | Only needed if you want to use your Raspberry Pi V4L2 video encoding. |
191197

192198
## Environment variables from files (Docker secrets)
193199

@@ -206,6 +212,21 @@ Will set the environment variable `MYVAR` based on the contents of the `/run/sec
206212
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.
207213
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
208214

215+
## Optional Parameters
216+
217+
The [official documentation for ports](https://jellyfin.org/docs/general/networking/index.html) has additional ports that can provide auto discovery.
218+
219+
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.
220+
221+
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.
222+
223+
```
224+
-p 7359:7359/udp \
225+
-p 1900:1900/udp \
226+
```
227+
228+
The [official documentation for environmentals](https://jellyfin.org/docs/general/administration/configuration.html) has additional environmentals that can provide additional configurability such as migrating to the native Jellyfin image.
229+
209230
## User / Group Identifiers
210231

211232
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`.
@@ -350,6 +371,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
350371

351372
## Versions
352373

374+
* **01.05.24:** - Increase verbosity of device permissions fixing. Use universal hardware acceleration blurb.
353375
* **03.12.23:** - Switch nightly to ffmpeg6.
354376
* **01.07.23:** - Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)
355377
* **07.12.22:** - Rebase nightly to Jammy, migrate to s6v3.

0 commit comments

Comments
 (0)