docker-documentation/images/docker-jellyfin.md

170 wiersze
7.6 KiB
Markdown
Czysty Zwykły widok Historia

2019-10-02 21:15:17 +00:00
# [linuxserver/jellyfin](https://github.com/linuxserver/docker-jellyfin)
2019-06-11 10:28:59 +00:00
2019-10-02 21:15:17 +00:00
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-jellyfin.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-jellyfin/releases)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/jellyfin.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/jellyfin "Get your own version badge on microbadger.com")
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/jellyfin.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/jellyfin "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/jellyfin.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/jellyfin)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/jellyfin.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/jellyfin)
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-jellyfin/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-jellyfin/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/jellyfin/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/jellyfin/latest/index.html)
2019-06-11 10:28:59 +00:00
[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.
## Supported Architectures
2019-09-01 06:14:00 +00:00
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2019-06-11 10:28:59 +00:00
Simply pulling `linuxserver/jellyfin` 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 | Tag |
2019-10-02 21:15:17 +00:00
| :----: | --- |
2019-06-11 10:28:59 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
2019-10-02 21:15:17 +00:00
2019-06-11 10:28:59 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-10-02 21:15:17 +00:00
```
2019-06-11 10:28:59 +00:00
docker create \
--name=jellyfin \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
2019-08-13 17:41:15 +00:00
-e UMASK_SET=<022> `#optional` \
2019-06-11 10:28:59 +00:00
-p 8096:8096 \
-p 8920:8920 `#optional` \
-v </path/to/library>:/config \
-v <path/to/tvseries>:/data/tvshows \
-v </path/to/movies>:/data/movies \
-v </path for transcoding>:/transcode `#optional` \
--device /dev/dri:/dev/dri `#optional` \
--restart unless-stopped \
linuxserver/jellyfin
```
2019-10-02 21:15:17 +00:00
2019-06-11 10:28:59 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
jellyfin:
image: linuxserver/jellyfin
container_name: jellyfin
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
2019-08-13 17:41:15 +00:00
- UMASK_SET=<022> #optional
2019-06-11 10:28:59 +00:00
volumes:
- </path/to/library>:/config
- <path/to/tvseries>:/data/tvshows
- </path/to/movies>:/data/movies
volumes:
- </path for transcoding>:/transcode #optional
ports:
- 8096:8096
ports:
- 8920:8920 #optional
devices:
- /dev/dri:/dev/dri #optional
restart: unless-stopped
```
## Parameters
2019-10-02 21:15:17 +00:00
Docker images 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.
2019-06-11 10:28:59 +00:00
2019-10-02 21:15:17 +00:00
### Ports (`-p`)
2019-06-11 10:28:59 +00:00
| Parameter | Function |
2019-10-02 21:15:17 +00:00
| :----: | --- |
2019-06-11 10:28:59 +00:00
| `8096` | Http webUI. |
2019-10-02 21:15:17 +00:00
| `8920` | Https webUI (you need to setup your own certificate). |
2019-06-11 10:28:59 +00:00
2019-10-02 21:15:17 +00:00
### Environment Variables (`-e`)
2019-06-11 10:28:59 +00:00
| Env | Function |
2019-10-02 21:15:17 +00:00
| :----: | --- |
2019-06-11 10:28:59 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
2019-08-13 17:41:15 +00:00
| `UMASK_SET=<022>` | for umask setting of Emby, default if left unset is 022. |
2019-06-11 10:28:59 +00:00
2019-10-02 21:15:17 +00:00
### Volume Mappings (`-v`)
2019-06-11 10:28:59 +00:00
| Volume | Function |
2019-10-02 21:15:17 +00:00
| :----: | --- |
| `/config` | Jellyfin data storage location. *This can grow very large, 50gb+ is likely for a large collection.* |
2019-06-11 10:28:59 +00:00
| `/data/tvshows` | Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc. |
| `/data/movies` | Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc. |
2019-10-02 21:15:17 +00:00
| `/transcode` | Path for transcoding folder, *optional*. |
2019-06-11 10:28:59 +00:00
2019-10-02 21:15:17 +00:00
#### Device Mappings (`--device`)
2019-09-29 09:44:22 +00:00
| Parameter | Function |
2019-10-02 21:15:17 +00:00
| :-----: | --- |
| `/dev/dri` | Only needed if you want to use your Intel GPU for hardware accelerated video encoding (vaapi). |
2019-06-11 10:28:59 +00:00
## User / Group Identifiers
2019-10-02 21:15:17 +00:00
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`.
2019-06-11 10:28:59 +00:00
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 user` as below:
2019-10-02 21:15:17 +00:00
```
2019-06-11 10:28:59 +00:00
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Application Setup
Webui can be found at `http://<your-ip>:8096`
More information can be found in their official documentation [here](https://github.com/MediaBrowser/Wiki/wiki) .
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:
2019-10-02 21:15:17 +00:00
```--device=/dev/dri:/dev/dri```
2019-06-11 10:28:59 +00:00
We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:
2019-10-02 21:15:17 +00:00
https://github.com/NVIDIA/nvidia-docker
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.
2019-06-11 10:28:59 +00:00
## Support Info
2019-09-01 06:14:00 +00:00
* Shell access whilst the container is running:
2019-06-11 10:28:59 +00:00
* `docker exec -it jellyfin /bin/bash`
2019-09-01 06:14:00 +00:00
* To monitor the logs of the container in realtime:
2019-06-11 10:28:59 +00:00
* `docker logs -f jellyfin`
2019-09-01 06:14:00 +00:00
* Container version number
2019-06-11 10:28:59 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' jellyfin`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/jellyfin`
## Versions
2019-10-02 21:15:17 +00:00
* **02.10.19:** - Improve permission fixing for render & dvb devices.
2019-08-03 19:24:12 +00:00
* **31.07.19:** - Add AMD drivers for vaapi support on x86.
2019-06-13 23:05:22 +00:00
* **13.06.19:** - Add Intel drivers for vaapi support on x86.
2019-06-11 10:28:59 +00:00
* **07.06.19:** - Initial release.