mirror of
https://github.com/jellyfin/jellyfin.org.git
synced 2026-09-03 05:30:05 +03:00
Merge pull request #1477 from felix920506/install-container-tabs
Use tabs for container installation instructions
This commit is contained in:
Niels van Velzen
@@ -0,0 +1,87 @@
|
||||
<!-- markdownlint-disable MD041 -->
|
||||
|
||||
[Docker](https://www.docker.com/) allows you to run containers on Linux, Windows and MacOS.
|
||||
|
||||
:::warning
|
||||
|
||||
If you wish to use Windows or macOS, please install Jellyfin natively instead. [Windows](/docs/general/installation/windows) [macOS](/docs/general/installation/macos).
|
||||
|
||||
While it is possible to run Jellyfin in Docker on a Windows or macOS host, it is NOT supported. Some features are known to be broken when running in Docker on platforms other than Linux, Notably:
|
||||
|
||||
- Hardware Accelerated Transcoding
|
||||
- [Scanning on macOS in Docker](https://github.com/jellyfin/jellyfin/issues/13093)
|
||||
|
||||
You WILL NOT receive any support for running Jellyfin in Docker on platforms other than Linux.
|
||||
|
||||
:::
|
||||
|
||||
The basic steps to create and run a Jellyfin container using Docker are as follows.
|
||||
|
||||
1. Follow the [official installation guide to install Docker](https://docs.docker.com/engine/install).
|
||||
|
||||
2. Download the latest container image.
|
||||
|
||||
```sh
|
||||
docker pull jellyfin/jellyfin
|
||||
```
|
||||
|
||||
3. Create persistent storage for configuration and cache data.
|
||||
|
||||
Either create two directories on the host and use bind mounts:
|
||||
|
||||
```sh
|
||||
mkdir /path/to/config
|
||||
mkdir /path/to/cache
|
||||
```
|
||||
|
||||
Or create two persistent volumes:
|
||||
|
||||
```sh
|
||||
docker volume create jellyfin-config
|
||||
docker volume create jellyfin-cache
|
||||
```
|
||||
|
||||
4. Create and run a container in one of the following ways.
|
||||
|
||||
:::note
|
||||
|
||||
The default network mode for Docker is bridge mode. Bridge mode will be used if host mode is omitted.
|
||||
Using host networking (`--net=host`) is optional but required in order to use DLNA.
|
||||
|
||||
:::
|
||||
|
||||
**Using Docker command line interface:**
|
||||
|
||||
```sh
|
||||
docker run -d \
|
||||
--name jellyfin \
|
||||
--user uid:gid \
|
||||
--net=host \
|
||||
--volume /path/to/config:/config \ # Alternatively --volume jellyfin-config:/config
|
||||
--volume /path/to/cache:/cache \ # Alternatively --volume jellyfin-cache:/cache
|
||||
--mount type=bind,source=/path/to/media,target=/media \
|
||||
--restart=unless-stopped \
|
||||
jellyfin/jellyfin
|
||||
```
|
||||
|
||||
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.
|
||||
Multiple media libraries can be bind mounted if needed:
|
||||
|
||||
```sh
|
||||
--mount type=bind,source=/path/to/media1,target=/media1
|
||||
--mount type=bind,source=/path/to/media2,target=/media2,readonly
|
||||
...etc
|
||||
```
|
||||
|
||||
Custom [server-side system fonts](/docs/general/administration/configuration/#server-side-system-fonts) directory can be optionally bind mounted in order to use these fonts during transcoding with subtitle burn-in:
|
||||
|
||||
```sh
|
||||
--mount type=bind,source=/path/to/fonts,target=/usr/local/share/fonts/custom,readonly
|
||||
```
|
||||
|
||||
A directory of [fallback fonts](/docs/general/administration/configuration/#fallback-fonts) can be mounted as well. In this case, you will have to set the directory of fallback fonts to `/fallback_fonts` in Jellyfin server settings panel:
|
||||
|
||||
```sh
|
||||
--mount type=bind,source=/path/to/fallback/fonts,target=/fallback_fonts,readonly
|
||||
```
|
||||
@@ -0,0 +1,57 @@
|
||||
<!-- markdownlint-disable MD041 -->
|
||||
|
||||
:::warning
|
||||
|
||||
If you wish to use Windows or macOS, please install Jellyfin natively instead. [Windows](/docs/general/installation/windows) [macOS](/docs/general/installation/macos).
|
||||
|
||||
While it is possible to run Jellyfin in Docker on a Windows or macOS host, it is NOT supported. Some features are known to be broken when running in Docker on platforms other than Linux, Notably:
|
||||
|
||||
- Hardware Accelerated Transcoding
|
||||
- [Scanning on macOS in Docker](https://github.com/jellyfin/jellyfin/issues/13093)
|
||||
|
||||
You WILL NOT receive any support for running Jellyfin in Docker on platforms other than Linux.
|
||||
|
||||
:::
|
||||
|
||||
Create a `docker-compose.yml` file with the following contents. Add in the UID and GID that you would like to run jellyfin as in the user line below, or remove the user line to use the default (root).
|
||||
|
||||
```yml
|
||||
services:
|
||||
jellyfin:
|
||||
image: jellyfin/jellyfin
|
||||
container_name: jellyfin
|
||||
user: uid:gid
|
||||
network_mode: 'host'
|
||||
volumes:
|
||||
- /path/to/config:/config
|
||||
- /path/to/cache:/cache
|
||||
- type: bind
|
||||
source: /path/to/media
|
||||
target: /media
|
||||
- type: bind
|
||||
source: /path/to/media2
|
||||
target: /media2
|
||||
read_only: true
|
||||
# Optional - extra fonts to be used during transcoding with subtitle burn-in
|
||||
- type: bind
|
||||
source: /path/to/fonts
|
||||
target: /usr/local/share/fonts/custom
|
||||
read_only: true
|
||||
restart: 'unless-stopped'
|
||||
# Optional - alternative address used for autodiscovery
|
||||
environment:
|
||||
- JELLYFIN_PublishedServerUrl=http://example.com
|
||||
# Optional - may be necessary for docker healthcheck to pass if running in host network mode
|
||||
extra_hosts:
|
||||
- 'host.docker.internal:host-gateway'
|
||||
```
|
||||
|
||||
Then while in the same folder as the `docker-compose.yml` run:
|
||||
|
||||
```sh
|
||||
docker compose up
|
||||
```
|
||||
|
||||
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](https://docs.docker.com/).
|
||||
@@ -0,0 +1,180 @@
|
||||
<!-- markdownlint-disable MD041 -->
|
||||
|
||||
[Podman](https://podman.io) allows you to run rootless containers.
|
||||
Steps to run Jellyfin using Podman are similar to the Docker steps.
|
||||
|
||||
1. Install Podman:
|
||||
|
||||
```sh
|
||||
sudo dnf install -y podman
|
||||
```
|
||||
|
||||
2. Create and run a Jellyfin container:
|
||||
|
||||
```sh
|
||||
podman run \
|
||||
--detach \
|
||||
--label "io.containers.autoupdate=registry" \
|
||||
--name myjellyfin \
|
||||
--publish 8096:8096/tcp \
|
||||
--rm \
|
||||
--user $(id -u):$(id -g) \
|
||||
--userns keep-id \
|
||||
--volume jellyfin-cache:/cache:Z \
|
||||
--volume jellyfin-config:/config:Z \
|
||||
--mount type=bind,source=/path/to/media,destination=/media,ro=true,relabel=private \
|
||||
docker.io/jellyfin/jellyfin:latest
|
||||
```
|
||||
|
||||
3. Open the necessary ports in your machine's firewall if you wish to permit access to the Jellyfin server from outside the host.
|
||||
This is not done automatically when using rootless Podman.
|
||||
If your distribution uses `firewalld`, the following commands save and load a new firewall rule opening the HTTP port `8096` for TCP connections.
|
||||
|
||||
```sh
|
||||
sudo firewall-cmd --add-port=8096/tcp --permanent
|
||||
sudo firewall-cmd --reload
|
||||
```
|
||||
|
||||
Podman doesn't require root access to run containers, although there are some details to be mindful of; see [the relevant documentation](https://docs.podman.io/en/latest/markdown/podman.1.html#rootless-mode).
|
||||
For security, the Jellyfin container should be run using rootless Podman.
|
||||
Furthermore, it is safer to run as a non-root user within the container.
|
||||
The `--user` option will run with the provided user id and group id _inside_ the container.
|
||||
The `--userns keep-id` flag ensures that current user's id is mapped to the non-root user's id inside the container.
|
||||
This ensures that the permissions for directories bind-mounted inside the container are mapped correctly between the user running Podman and the user running Jellyfin inside the container.
|
||||
|
||||
Keep in mind that the `--label "io.containers.autoupdate=image"` flag will allow the container to be automatically updated via `podman auto-update`.
|
||||
|
||||
The `z` (shared volume) or `Z` (private volume) volume option and `relabel=shared` or `relabel=private` mount option tell Podman to relabel files inside the volumes as appropriate, for systems running SELinux.
|
||||
|
||||
Replace `jellyfin-config` and `jellyfin-cache` with `/path/to/config` and `/path/to/cache` if you wish to use bind mounts.
|
||||
|
||||
This example mounts your media library read-only by setting `ro=true`; set this to `ro=false` if you wish to give Jellyfin write access to your media.
|
||||
|
||||
<details>
|
||||
<summary>Managing via systemd</summary>
|
||||
|
||||
To run as a systemd service see [podman-systemd.unit](https://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html).
|
||||
|
||||
As always it is recommended to run the container rootless. Therefore we want to manage the container with the `systemd --user` flag.
|
||||
|
||||
1. Create a new user that the rootless container will run under.
|
||||
|
||||
`useradd jellyfin`
|
||||
|
||||
This allows users who are not logged in to run long-running services.
|
||||
|
||||
`loginctl enable-linger jellyfin`
|
||||
|
||||
Open an interactive shell session.
|
||||
|
||||
`machinectl shell jellyfin@`
|
||||
|
||||
2. Install `.config/containers/systemd/jellyfin.container`
|
||||
|
||||
> Contents of `~/.config/containers/systemd/jellyfin.container`
|
||||
|
||||
```ini
|
||||
[Container]
|
||||
Image=docker.io/jellyfin/jellyfin:latest
|
||||
AutoUpdate=registry
|
||||
PublishPort=8096:8096/tcp
|
||||
UserNS=keep-id
|
||||
Volume=jellyfin-config:/config:Z
|
||||
Volume=jellyfin-cache:/cache:Z
|
||||
Volume=jellyfin-media:/media:Z
|
||||
|
||||
[Service]
|
||||
# Inform systemd of additional exit status
|
||||
SuccessExitStatus=0 143
|
||||
|
||||
[Install]
|
||||
# Start by default on boot
|
||||
WantedBy=default.target
|
||||
```
|
||||
|
||||
3. Reload daemon and start the service.
|
||||
|
||||
`systemctl --user daemon-reload`
|
||||
|
||||
`systemctl --user start jellyfin`
|
||||
|
||||
4. To enable Podman auto-updates, enable the necessary systemd timer.
|
||||
|
||||
`systemctl --user enable --now podman-auto-update.timer`
|
||||
|
||||
5. Optionally check logs for errors
|
||||
|
||||
`journalctl --user -u jellyfin`
|
||||
|
||||
6. `exit` the current session.
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Using hardware acceleration</summary>
|
||||
|
||||
To use hardware acceleration, you need to allow the container to access the render device. If you are using container-selinux-2.226 or later, you have to set the `container_use_dri_devices` flag in selinux or the container will not be able to use it:
|
||||
|
||||
`sudo setsebool -P container_use_dri_devices 1`
|
||||
|
||||
On older versions of container-selinux, you have to disable the selinux confinement for the container by adding `--security-opt label=disable` to the podman command.
|
||||
|
||||
Then, you need to mount the render device inside the container:
|
||||
|
||||
`--device /dev/dri/:/dev/dri/`
|
||||
|
||||
Finally, you need to set the `--device` flag for the container to use the render device:
|
||||
|
||||
`--device /dev/dri/`
|
||||
|
||||
Podman run example:
|
||||
|
||||
```sh
|
||||
podman run \
|
||||
--detach \
|
||||
--label "io.containers.autoupdate=registry" \
|
||||
--name myjellyfin \
|
||||
--publish 8096:8096/tcp \
|
||||
--device /dev/dri/:/dev/dri/ \
|
||||
# --security-opt label=disable # Only needed for older versions of container-selinux < 2.226
|
||||
--rm \
|
||||
--user $(id -u):$(id -g) \
|
||||
--userns keep-id \
|
||||
--volume jellyfin-cache:/cache:Z \
|
||||
--volume jellyfin-config:/config:Z \
|
||||
--mount type=bind,source=/path/to/media,destination=/media,ro=true,relabel=private \
|
||||
docker.io/jellyfin/jellyfin:latest
|
||||
```
|
||||
|
||||
systemd example:
|
||||
|
||||
```ini
|
||||
[Unit]
|
||||
Description=jellyfin
|
||||
|
||||
[Container]
|
||||
Image=docker.io/jellyfin/jellyfin:latest
|
||||
AutoUpdate=registry
|
||||
PublishPort=8096:8096/tcp
|
||||
UserNS=keep-id
|
||||
#SecurityLabelDisable=true # Only needed for older versions of container-selinux < 2.226
|
||||
AddDevice=/dev/dri/:/dev/dri/
|
||||
Volume=jellyfin-config:/config:Z
|
||||
Volume=jellyfin-cache:/cache:Z
|
||||
Volume=jellyfin-media:/media:Z
|
||||
|
||||
[Service]
|
||||
# Inform systemd of additional exit status
|
||||
SuccessExitStatus=0 143
|
||||
|
||||
[Install]
|
||||
# Start by default on boot
|
||||
WantedBy=default.target
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Vendor-specific configuration</summary>
|
||||
|
||||
Additional configuration steps may be required depending on your GPU vendor. Check the [Hardware Acceleration](/docs/general/post-install/transcoding/hardware-acceleration) section.
|
||||
|
||||
</details>
|
||||
@@ -94,7 +94,7 @@ A tab will open from the right side of the page where you launch your custom app
|
||||
|
||||
Here, give the custom app a name and write/paste the lines for your compose file.
|
||||
|
||||
See here for [documentation on using Docker Compose with Jellyfin](/docs/general/installation/container#using-docker-compose).
|
||||
See here for [documentation on using Docker Compose with Jellyfin](/docs/general/installation/container?method=docker-compose).
|
||||
Alternatively, here's a basic compose file where you should edit the volumes to use on your system, then copy & paste it into the editor to launch Jellyfin:
|
||||
|
||||
```yml
|
||||
|
||||
@@ -21,309 +21,28 @@ These images are based on Debian and [built directly from the Jellyfin source co
|
||||
|
||||
Additionally, there are several third parties providing unofficial container images, including the [LinuxServer.io](https://www.linuxserver.io/) ([Dockerfile](https://github.com/linuxserver/docker-jellyfin/blob/master/Dockerfile)) project and [hotio](https://github.com/hotio) ([Dockerfile](https://github.com/hotio/jellyfin/blob/release/linux-amd64.Dockerfile)), which offer images based on Ubuntu and the official Jellyfin Ubuntu binary packages.
|
||||
|
||||
## Docker
|
||||
## Installation Instructions
|
||||
|
||||
[Docker](https://www.docker.com/) allows you to run containers on Linux, Windows and MacOS.
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import DockerCli from './\_container-docker-cli.md';
|
||||
import DockerCompose from './\_container-docker-compose.md';
|
||||
import Podman from './\_container-podman.md';
|
||||
|
||||
:::warning
|
||||
<Tabs queryString="method">
|
||||
<TabItem value="docker-cli" label="Docker">
|
||||
|
||||
If you wish to use Windows or macOS, please install Jellyfin natively instead. [Windows](/docs/general/installation/windows) [macOS](/docs/general/installation/macos).
|
||||
<DockerCli />
|
||||
|
||||
While it is possible to run Jellyfin in Docker on a Windows or macOS host, it is NOT supported. Some features are known to be broken when running in Docker on platforms other than Linux, Notably:
|
||||
</TabItem>
|
||||
<TabItem value="docker-compose" label="Docker Compose" default>
|
||||
|
||||
- Hardware Accelerated Transcoding
|
||||
- [Scanning on macOS in Docker](https://github.com/jellyfin/jellyfin/issues/13093)
|
||||
<DockerCompose />
|
||||
|
||||
You WILL NOT receive any support for running Jellyfin in Docker on platforms other than Linux.
|
||||
</TabItem>
|
||||
<TabItem value="podman" label="Podman">
|
||||
|
||||
:::
|
||||
<Podman />
|
||||
|
||||
The basic steps to create and run a Jellyfin container using Docker are as follows.
|
||||
|
||||
1. Follow the [official installation guide to install Docker](https://docs.docker.com/engine/install).
|
||||
|
||||
2. Download the latest container image.
|
||||
|
||||
```sh
|
||||
docker pull jellyfin/jellyfin
|
||||
```
|
||||
|
||||
3. Create persistent storage for configuration and cache data.
|
||||
|
||||
Either create two directories on the host and use bind mounts:
|
||||
|
||||
```sh
|
||||
mkdir /path/to/config
|
||||
mkdir /path/to/cache
|
||||
```
|
||||
|
||||
Or create two persistent volumes:
|
||||
|
||||
```sh
|
||||
docker volume create jellyfin-config
|
||||
docker volume create jellyfin-cache
|
||||
```
|
||||
|
||||
4. Create and run a container in one of the following ways.
|
||||
|
||||
:::note
|
||||
|
||||
The default network mode for Docker is bridge mode. Bridge mode will be used if host mode is omitted.
|
||||
Using host networking (`--net=host`) is optional but required in order to use DLNA.
|
||||
|
||||
:::
|
||||
|
||||
**Using Docker command line interface:**
|
||||
|
||||
```sh
|
||||
docker run -d \
|
||||
--name jellyfin \
|
||||
--user uid:gid \
|
||||
--net=host \
|
||||
--volume /path/to/config:/config \ # Alternatively --volume jellyfin-config:/config
|
||||
--volume /path/to/cache:/cache \ # Alternatively --volume jellyfin-cache:/cache
|
||||
--mount type=bind,source=/path/to/media,target=/media \
|
||||
--restart=unless-stopped \
|
||||
jellyfin/jellyfin
|
||||
```
|
||||
|
||||
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.
|
||||
Multiple media libraries can be bind mounted if needed:
|
||||
|
||||
```sh
|
||||
--mount type=bind,source=/path/to/media1,target=/media1
|
||||
--mount type=bind,source=/path/to/media2,target=/media2,readonly
|
||||
...etc
|
||||
```
|
||||
|
||||
Custom [server-side system fonts](/docs/general/administration/configuration/#server-side-system-fonts) directory can be optionally bind mounted in order to use these fonts during transcoding with subtitle burn-in:
|
||||
|
||||
```sh
|
||||
--mount type=bind,source=/path/to/fonts,target=/usr/local/share/fonts/custom,readonly
|
||||
```
|
||||
|
||||
A directory of [fallback fonts](/docs/general/administration/configuration/#fallback-fonts) can be mounted as well. In this case, you will have to set the directory of fallback fonts to `/fallback_fonts` in Jellyfin server settings panel:
|
||||
|
||||
```sh
|
||||
--mount type=bind,source=/path/to/fallback/fonts,target=/fallback_fonts,readonly
|
||||
```
|
||||
|
||||
### Using Docker Compose
|
||||
|
||||
Create a `docker-compose.yml` file with the following contents. Add in the UID and GID that you would like to run jellyfin as in the user line below, or remove the user line to use the default (root).
|
||||
|
||||
```yml
|
||||
services:
|
||||
jellyfin:
|
||||
image: jellyfin/jellyfin
|
||||
container_name: jellyfin
|
||||
user: uid:gid
|
||||
network_mode: 'host'
|
||||
volumes:
|
||||
- /path/to/config:/config
|
||||
- /path/to/cache:/cache
|
||||
- type: bind
|
||||
source: /path/to/media
|
||||
target: /media
|
||||
- type: bind
|
||||
source: /path/to/media2
|
||||
target: /media2
|
||||
read_only: true
|
||||
# Optional - extra fonts to be used during transcoding with subtitle burn-in
|
||||
- type: bind
|
||||
source: /path/to/fonts
|
||||
target: /usr/local/share/fonts/custom
|
||||
read_only: true
|
||||
restart: 'unless-stopped'
|
||||
# Optional - alternative address used for autodiscovery
|
||||
environment:
|
||||
- JELLYFIN_PublishedServerUrl=http://example.com
|
||||
# Optional - may be necessary for docker healthcheck to pass if running in host network mode
|
||||
extra_hosts:
|
||||
- 'host.docker.internal:host-gateway'
|
||||
```
|
||||
|
||||
Then while in the same folder as the `docker-compose.yml` run:
|
||||
|
||||
```sh
|
||||
docker compose up
|
||||
```
|
||||
|
||||
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](https://docs.docker.com/).
|
||||
|
||||
## Podman
|
||||
|
||||
[Podman](https://podman.io) allows you to run rootless containers.
|
||||
Steps to run Jellyfin using Podman are similar to the Docker steps.
|
||||
|
||||
1. Install Podman:
|
||||
|
||||
```sh
|
||||
sudo dnf install -y podman
|
||||
```
|
||||
|
||||
2. Create and run a Jellyfin container:
|
||||
|
||||
```sh
|
||||
podman run \
|
||||
--detach \
|
||||
--label "io.containers.autoupdate=registry" \
|
||||
--name myjellyfin \
|
||||
--publish 8096:8096/tcp \
|
||||
--rm \
|
||||
--user $(id -u):$(id -g) \
|
||||
--userns keep-id \
|
||||
--volume jellyfin-cache:/cache:Z \
|
||||
--volume jellyfin-config:/config:Z \
|
||||
--mount type=bind,source=/path/to/media,destination=/media,ro=true,relabel=private \
|
||||
docker.io/jellyfin/jellyfin:latest
|
||||
```
|
||||
|
||||
3. Open the necessary ports in your machine's firewall if you wish to permit access to the Jellyfin server from outside the host.
|
||||
This is not done automatically when using rootless Podman.
|
||||
If your distribution uses `firewalld`, the following commands save and load a new firewall rule opening the HTTP port `8096` for TCP connections.
|
||||
|
||||
```sh
|
||||
sudo firewall-cmd --add-port=8096/tcp --permanent
|
||||
sudo firewall-cmd --reload
|
||||
```
|
||||
|
||||
Podman doesn't require root access to run containers, although there are some details to be mindful of; see [the relevant documentation](https://docs.podman.io/en/latest/markdown/podman.1.html#rootless-mode).
|
||||
For security, the Jellyfin container should be run using rootless Podman.
|
||||
Furthermore, it is safer to run as a non-root user within the container.
|
||||
The `--user` option will run with the provided user id and group id _inside_ the container.
|
||||
The `--userns keep-id` flag ensures that current user's id is mapped to the non-root user's id inside the container.
|
||||
This ensures that the permissions for directories bind-mounted inside the container are mapped correctly between the user running Podman and the user running Jellyfin inside the container.
|
||||
|
||||
Keep in mind that the `--label "io.containers.autoupdate=image"` flag will allow the container to be automatically updated via `podman auto-update`.
|
||||
|
||||
The `z` (shared volume) or `Z` (private volume) volume option and `relabel=shared` or `relabel=private` mount option tell Podman to relabel files inside the volumes as appropriate, for systems running SELinux.
|
||||
|
||||
Replace `jellyfin-config` and `jellyfin-cache` with `/path/to/config` and `/path/to/cache` if you wish to use bind mounts.
|
||||
|
||||
This example mounts your media library read-only by setting `ro=true`; set this to `ro=false` if you wish to give Jellyfin write access to your media.
|
||||
|
||||
### Managing via Systemd
|
||||
|
||||
To run as a systemd service see [podman-systemd.unit](https://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html).
|
||||
|
||||
As always it is recommended to run the container rootless. Therefore we want to manage the container with the `systemd --user` flag.
|
||||
|
||||
1. Create a new user that the rootless container will run under.
|
||||
|
||||
`useradd jellyfin`
|
||||
|
||||
This allows users who are not logged in to run long-running services.
|
||||
|
||||
`loginctl enable-linger jellyfin`
|
||||
|
||||
Open an interactive shell session.
|
||||
|
||||
`machinectl shell jellyfin@`
|
||||
|
||||
2. Install `.config/containers/systemd/jellyfin.container`
|
||||
|
||||
> Contents of `~/.config/containers/systemd/jellyfin.container`
|
||||
|
||||
```sh
|
||||
[Container]
|
||||
Image=docker.io/jellyfin/jellyfin:latest
|
||||
AutoUpdate=registry
|
||||
PublishPort=8096:8096/tcp
|
||||
UserNS=keep-id
|
||||
Volume=jellyfin-config:/config:Z
|
||||
Volume=jellyfin-cache:/cache:Z
|
||||
Volume=jellyfin-media:/media:Z
|
||||
|
||||
[Service]
|
||||
# Inform systemd of additional exit status
|
||||
SuccessExitStatus=0 143
|
||||
|
||||
[Install]
|
||||
# Start by default on boot
|
||||
WantedBy=default.target
|
||||
```
|
||||
|
||||
3. Reload daemon and start the service.
|
||||
|
||||
`systemctl --user daemon-reload`
|
||||
|
||||
`systemctl --user start jellyfin`
|
||||
|
||||
4. To enable Podman auto-updates, enable the necessary systemd timer.
|
||||
|
||||
`systemctl --user enable --now podman-auto-update.timer`
|
||||
|
||||
5. Optionally check logs for errors
|
||||
|
||||
`journalctl --user -u jellyfin`
|
||||
|
||||
6. `exit` the current session.
|
||||
|
||||
### With hardware acceleration
|
||||
|
||||
To use hardware acceleration, you need to allow the container to access the render device. If you are using container-selinux-2.226 or later, you have to set the `container_use_dri_devices` flag in selinux or the container will not be able to use it:
|
||||
|
||||
`sudo setsebool -P container_use_dri_devices 1`
|
||||
|
||||
On older versions of container-selinux, you have to disable the selinux confinement for the container by adding `--security-opt label=disable` to the podman command.
|
||||
|
||||
Then, you need to mount the render device inside the container:
|
||||
|
||||
`--device /dev/dri/:/dev/dri/`
|
||||
|
||||
Finally, you need to set the `--device` flag for the container to use the render device:
|
||||
|
||||
`--device /dev/dri/`
|
||||
|
||||
#### podman run
|
||||
|
||||
```sh
|
||||
podman run \
|
||||
--detach \
|
||||
--label "io.containers.autoupdate=registry" \
|
||||
--name myjellyfin \
|
||||
--publish 8096:8096/tcp \
|
||||
--device /dev/dri/:/dev/dri/ \
|
||||
# --security-opt label=disable # Only needed for older versions of container-selinux < 2.226
|
||||
--rm \
|
||||
--user $(id -u):$(id -g) \
|
||||
--userns keep-id \
|
||||
--volume jellyfin-cache:/cache:Z \
|
||||
--volume jellyfin-config:/config:Z \
|
||||
--mount type=bind,source=/path/to/media,destination=/media,ro=true,relabel=private \
|
||||
docker.io/jellyfin/jellyfin:latest
|
||||
```
|
||||
|
||||
#### systemd
|
||||
|
||||
```sh
|
||||
[Unit]
|
||||
Description=jellyfin
|
||||
|
||||
[Container]
|
||||
Image=docker.io/jellyfin/jellyfin:latest
|
||||
AutoUpdate=registry
|
||||
PublishPort=8096:8096/tcp
|
||||
UserNS=keep-id
|
||||
#SecurityLabelDisable=true # Only needed for older versions of container-selinux < 2.226
|
||||
AddDevice=/dev/dri/:/dev/dri/
|
||||
Volume=jellyfin-config:/config:Z
|
||||
Volume=jellyfin-cache:/cache:Z
|
||||
Volume=jellyfin-media:/media:Z
|
||||
|
||||
[Service]
|
||||
# Inform systemd of additional exit status
|
||||
SuccessExitStatus=0 143
|
||||
|
||||
[Install]
|
||||
# Start by default on boot
|
||||
WantedBy=default.target
|
||||
```
|
||||
|
||||
#### Vendor-specific configuration
|
||||
|
||||
Additional configuration steps may be required depending on your GPU vendor. Check the [Hardware Acceleration](/docs/general/post-install/transcoding/hardware-acceleration) section.
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
Reference in New Issue
Block a user