$ docker images REPOSITORY TAG ID ubuntu 12.10 b750fe78269d me/myapp latest 7b2431a8d968. Docker-compose start docker-compose stop. Official IBM WebSphere Application Server for Developers Liberty image.
The Jellyfin project and its contributors offer a number of pre-built binary packages to assist in getting Jellyfin up and running quickly on multiple systems.
Official container image: jellyfin/jellyfin
.
LinuxServer.io image: linuxserver/jellyfin
.
hotio image: hotio/jellyfin
.
Jellyfin distributes official container images on Docker Hub for multiple architectures. These images are based on Debian and built directly from the Jellyfin source code.
Additionally the LinuxServer.io project and hotio distribute images based on Ubuntu and the official Jellyfin Ubuntu binary packages, see here and here to see their Dockerfile.
For ARM hardware and RPi, it is recommended to use the LinuxServer.io or hotio image since hardware acceleration support is not yet available on the native image.
Docker allows you to run containers on Linux, Windows and MacOS.
The basic steps to create and run a Jellyfin container using Docker are as follows.
Follow the offical installation guide to install Docker.
Download the latest container image.
Create persistent storage for configuration and cache data.
Either create two persistent volumes:
Or create two directories on the host and use bind mounts:
Create and run a container in one of the following ways.
The default network mode for Docker is bridge mode. Bridge mode will be used if host mode is omitted. Use host mode for networking in order to use DLNA or an HDHomeRun.
Using Docker command line interface:
Using host networking (--net=host
) is optional but required in order to use DLNA or HDHomeRun.
Bind Mounts are needed to pass folders from the host OS to the container OS whereas volumes are maintained by Docker and can be considered easier to backup and control by external programs. For a simple setup, it's considered easier to use Bind Mounts instead of volumes. Replace jellyfin-config
and jellyfin-cache
with /path/to/config
and /path/to/cache
respectively if using bind mounts. Multiple media libraries can be bind mounted if needed:
There is currently an issue with read-only mounts in Docker. If there are submounts within the main mount, the submounts are read-write capable.
Using Docker Compose:
Create a docker-compose.yml
file with the following contents:
Then while in the same folder as the docker-compose.yml
run:
To run the container in background add -d
to the above command.
You can learn more about using Docker by reading the official Docker documentation.
You are able to use hardware encoding with Nvidia, but it requires some additional configuration. These steps require basic knowledge of Ubuntu but nothing too special.
Adding Package RepositoriesFirst off you'll need to add the Nvidia package repositories to your Ubuntu installation. This can be done by running the following commands:
Installing Nvidia container toolkitNext we'll need to install the Nvidia container toolkit. This can be done by running the following commands:
After installing the Nvidia Container Toolkit, you'll need to restart the Docker Daemon in order to let Docker use your Nvidia GPU:
Changing the docker-compose.yml
Now that all the packages are in order, let's change the docker-compose.yml
to let the Jellyfin container make use of the Nvidia GPU.The following lines need to be added to the file:
Your completed docker-compose.yml
file should look something like this:
For Nvidia Hardware encoding the minimum version of docker-compose needs to be 2. However we recommend sticking with version 2.3 as it has proven to work with nvenc encoding.
An Unraid Docker template is available in the repository.
Open the unRaid GUI (at least unRaid 6.5) and click on the 'Docker' tab.
Add the following line under 'Template Repositories' and save the options.
Click 'Add Container' and select 'jellyfin'.
Adjust any required paths and save your changes.
A community project to deploy Jellyfin on Kubernetes-based platforms exists at their repository. Any issues or feature requests related to deployment on Kubernetes-based platforms should be filed there.
Podman allows you to run containers as non-root. It's also the offically supported container solution on RHEL and CentOS.
Steps to run Jellyfin using Podman are almost identical to Docker steps:
Install Podman:
Download the latest container image:
Create persistent storage for configuration and cache data:
Either create two persistent volumes:
Or create two directories on the host and use bind mounts:
Create and run a Jellyfin container:
Note that Podman doesn't require root access and it's recommended to run the Jellyfin container as a separate non-root user for security.
If SELinux is enabled you need to use either --privileged
or supply z
volume option to allow Jellyfin to access the volumes.
Replace jellyfin-config
and jellyfin-cache
with /path/to/config
and /path/to/cache
respectively if using bind mounts.
To mount your media library read-only append ':ro' to the media volume:
To run as a systemd service see Running containers with Podman and shareable systemd services.
Cloudron is a complete solution for running apps on your server and keeping them up-to-date and secure. On your Cloudron you can install Jellyfin with a few clicks via the app library and updates are delivered automatically.
The source code for the package can be found here.Any issues or feature requests related to deployment on Cloudron should be filed there.
Windows installers and builds in ZIP archive format are available here.
If you installed a version prior to 10.4.0 using a PowerShell script, you will need to manually remove the service using the command nssm remove Jellyfin
and uninstall the server by remove all the files manually. Also one might need to move the data files to the correct location, or point the installer at the old location.
The 32-bit or x86 version is not recommended. ffmpeg
and its video encoders generally perform better as a 64-bit executable due to the extra registers provided. This means that the 32-bit version of Jellyfin is deprecated.
Install
Update
Uninstall
Add or remove programs
in Windows.Install
jellyfin
at your preferred install location.jellyfin
folder and rename it to system
.Create jellyfin.bat
within your jellyfin
folder containing:
To use the default library/data location at %localappdata%
:
To use a custom library/data location (Path after the -d parameter):
To use a custom library/data location (Path after the -d parameter) and disable the auto-start of the webapp:
Run
Open your browser at http://<--Server-IP-->:8096
(if auto-start of webapp is disabled)
Update
system
folder to system-bak
jellyfin
folder and rename it to system
jellyfin.bat
to start the server againRollback
system
folder.system-bak
to system
.jellyfin.bat
to start the server again.MacOS Application packages and builds in TAR archive format are available here.
Install
.app
package into the Applications folder.http://127.0.0.1:8096
.Upgrade
.app
package into the Applications folder and click yes to replace the files.http://127.0.0.1:8096
.Uninstall
.app
package to the trash.Deleting Configuation
This will delete all settings and user information. This applies for the .app package and the portable version.
~/.config/jellyfin/
~/.local/share/jellyfin/
Portable Version
cd
followed with a space then drag the jellyfin folder into the terminal../jellyfin
to run jellyfin.Closing the terminal window will end Jellyfin. Running Jellyfin in screen or tmux can prevent this from happening.
Upgrading the Portable Version
CTRL+C
in the terminal window.cd
followed with a space then drag the jellyfin folder into the terminal../jellyfin
to run jellyfin.Uninstalling the Portable Version
CTRL+C
in the terminal window./Application/jellyfin-version
folder to the Trash. Replace version with the actual version number you are trying to delete.Using FFmpeg with the Portable Version
The portable version doesn't come with FFmpeg by default, so to install FFmpeg you have three options.
brew install ffmpeg
into your Terminal (here's how to install homebrew if you don't have it alreadyMore detailed download options, documentation, and signatures can be found.
If using static build, extract it to the /Applications/
folder.
Navigate to the Playback tab in the Dashboard and set the path to FFmpeg under FFmpeg Path.
Generic amd64 Linux builds in TAR archive format are available here.
Create a directory in /opt
for jellyfin and its files, and enter that directory.
Download the latest generic Linux build from the release page. The generic Linux build ends with 'linux-amd64.tar.gz
'. The rest of these instructions assume version 10.4.3 is being installed (i.e. jellyfin_10.4.3_linux-amd64.tar.gz
). Download the generic build, then extract the archive:
Create a symbolic link to the Jellyfin 10.4.3 directory. This allows an upgrade by repeating the above steps and enabling it by simply re-creating the symbolic link to the new version.
Create four sub-directories for Jellyfin data.
If you are running Debian or a derivative, you can also download and install an ffmpeg release built specifically for Jellyfin. Be sure to download the latest release that matches your OS (4.2.1-5 for Debian Stretch assumed below).
If you run into any dependency errors, run this and it will install them and jellyfin-ffmpeg.
Due to the number of command line options that must be passed, it is easiest to create a small script to run Jellyfin.
Then paste the following commands and modify as needed.
Assuming you desire Jellyfin to run as a non-root user, chmod
all files and directories to your normal login user and group. Also make the startup script above executable.
Finally you can run it. You will see lots of log information when run, this is normal. Setup is as usual in the web browser.
Platform-agnostic .NET Core DLL builds in TAR archive format are available here. These builds use the binary jellyfin.dll
and must be loaded with dotnet
.
Jellyfin can be found in the AUR as jellyfin
, jellyfin-bin
and jellyfin-git
.
Fedora builds in RPM package format are available here for now but an official Fedora repository is coming soon.
You will need to enable rpmfusion as ffmpeg is a dependency of the jellyfin server package
You do not need to manually install ffmpeg, it will be installed by the jellyfin server package as a dependency
Install the jellyfin server
Install the jellyfin web interface
Enable jellyfin service with systemd
Open jellyfin service with firewalld
This will open the following ports8096 TCP used by default for HTTP traffic, you can change this in the dashboard8920 TCP used by default for HTTPS traffic, you can change this in the dashboard1900 UDP used for service auto-discovery, this is not configurable7359 UDP used for auto-discovery, this is not configurable
Reboot your box
Go to localhost:8096 or ip-address-of-jellyfin-server:8096 to finish setup in the web UI
CentOS/RHEL 7 builds in RPM package format are available here and an official CentOS/RHEL repository is planned for the future.
The default CentOS/RHEL repositories don't carry FFmpeg, which the RPM requires. You will need to add a third-party repository which carries FFmpeg, such as RPM Fusion's Free repository.
You can also build Jellyfin's version on your own. This includes gathering the dependencies and compiling and installing them. Instructions can be found at the FFmpeg wiki.
The Jellyfin team provides a Debian repository for installation on Debian Stretch/Buster. Supported architectures are amd64
, arm64
, and armhf
.
Microsoft does not provide a .NET for 32-bit x86 Linux systems, and hence Jellyfin is not supported on the i386
architecture.
Install HTTPS transport for APT as well as gnupg
and lsb-release
if you haven't already.
Import the GPG signing key (signed by the Jellyfin Team):
Add a repository configuration at /etc/apt/sources.list.d/jellyfin.list
:
Supported releases are stretch
, buster
, and bullseye
.
Update APT repositories:
Install Jellyfin:
Manage the Jellyfin system service with your tool of choice:
Raw Debian packages, including old versions, are available here.
The repository is the preferred way to obtain Jellyfin on Debian, as it contains several dependencies as well.
Download the desired jellyfin
and jellyfin-ffmpeg
.deb
packages from the repository.
Install the downloaded .deb
packages:
Use apt
to install any missing dependencies:
Manage the Jellyfin system service with your tool of choice:
Previous versions of Jellyfin included Ubuntu under the Debian repository. This has now been split out into its own repository to better handle the separate binary packages. If you encounter errors about the ubuntu
release not being found and you previously configured an ubuntu
jellyfin.list
file, please follow these steps.
Remove the old /etc/apt/sources.list.d/jellyfin.list
file:
Proceed with the following section as written.
The Jellyfin team provides an Ubuntu repository for installation on Ubuntu Xenial, Bionic, Cosmic, Disco, Eoan, and Focal. Supported architectures are amd64
, arm64
, and armhf
. Only amd64
is supported on Ubuntu Xenial.
Microsoft does not provide a .NET for 32-bit x86 Linux systems, and hence Jellyfin is not supported on the i386
architecture.
Install HTTPS transport for APT if you haven't already:
Enable the Universe repository to obtain all the FFMpeg dependencies:
If the above command fails you will need to install the following package software-properties-common
.This can be achieved with the following command sudo apt-get install software-properties-common
Import the GPG signing key (signed by the Jellyfin Team):
Add a repository configuration at /etc/apt/sources.list.d/jellyfin.list
:
Supported releases are xenial
, bionic
, cosmic
, disco
, eoan
, and focal
.
Update APT repositories:
Install Jellyfin:
Manage the Jellyfin system service with your tool of choice:
Raw Ubuntu packages, including old versions, are available here.
The repository is the preferred way to install Jellyfin on Ubuntu, as it contains several dependencies as well.
Enable the Universe repository to obtain all the FFMpeg dependencies, and update repositories:
Download the desired jellyfin
and jellyfin-ffmpeg
.deb
packages from the repository.
Install the required dependencies:
Install the downloaded .deb
packages:
Use apt
to install any missing dependencies:
Manage the Jellyfin system service with your tool of choice:
It's possible to map your local installation's files to the official docker image.
You need to have exactly matching paths for your files inside the docker container! This means that if your media is stored at /media/raid/
this path needs to be accessible at /media/raid/
inside the docker container too - the configurations below do include examples.
To guarantee proper permissions, get the uid
and gid
of your local jellyfin user and jellyfin group by running the following command:
You need to replace the <uid>:<gid>
placeholder below with the correct values.
Using docker
Using docker-compose
docker build
Create an image
from a Dockerfile.
docker run
Run a command in an image
.
docker create
Create a container
from an image
.
docker exec
Run commands in a container
.
docker start
Start/stop a container
.
docker ps
Manage container
s using ps/kill.
docker images
Manages image
s.
docker rmi
Deletes image
s.
Configures a container that will run as an executable.
This will use shell processing to substitute shell variables, and will ignore any CMD
or docker run
command line arguments.
To view list of all the services runnning in swarm
To see all running services
to see all services logs
To scale services quickly across qualified node
To clean or prune unused (dangling) images
To remove all images which are not in use containers , add - a
To Purne your entire system
To leave swarm
To remove swarm ( deletes all volume data and database info)
To kill all running containers
Sangam biradar - Docker Community Leader