mirror of
https://github.com/jellyfin/jellyfin.org.git
synced 2026-09-03 05:30:05 +03:00
Spelling fixes (#1724)
This commit is contained in:
@@ -224,7 +224,7 @@ You have 3 options to set the locking mode to:
|
||||
- `Optimistic` - Defines that all writes should be attempted and should be retried when they fail.
|
||||
- `Pessimistic` - Defines a behavior that always blocks all reads while any one write is done.
|
||||
|
||||
Stop your Jellyin server and navigate to its config directory. There are a lot of xml files, look for the `database.xml` file and edit the `LockingBehavior` option:
|
||||
Stop your Jellyfin server and navigate to its config directory. There are a lot of xml files, look for the `database.xml` file and edit the `LockingBehavior` option:
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
@@ -236,7 +236,7 @@ Stop your Jellyin server and navigate to its config directory. There are a lot o
|
||||
</DatabaseConfigurationOptions>
|
||||
```
|
||||
|
||||
then start your jellyfin instance again. If this still does not help with the issues, you can try setting the `LockingBehavior` to `Pessimistic` instead but this comes with a significant performance impact so it is only recommended when `Optimistic` does not help with the issues.
|
||||
then start your Jellyfin instance again. If this still does not help with the issues, you can try setting the `LockingBehavior` to `Pessimistic` instead but this comes with a significant performance impact so it is only recommended when `Optimistic` does not help with the issues.
|
||||
|
||||
### LXC specific issues
|
||||
|
||||
|
||||
@@ -48,7 +48,7 @@ The goal is to Direct Play all media. This means the container, video, audio and
|
||||
<br />
|
||||
<sup>12</sup>Need to be manually enabled in Settings > Playback > Enable H.264 High 10 Profile. Playback on Apple Silicon Macs with macOS version < 14 and Intel Macs with all macOS versions may result in blank frames if this is enabled.
|
||||
<br />
|
||||
<sup>13</sup>VP9 is only availble with Swiftfin (VLCKit) player.
|
||||
<sup>13</sup>VP9 is only available with Swiftfin (VLCKit) player.
|
||||
<br />
|
||||
<sup>14</sup>AV1 is enabled by default for Swiftfin (VLCKit). AV1 is disabled by default but can be enabled for Native (AVKit) using Custom Device Profiles. Enabling AV1 may result in a poor experience for SOCs prior to A17.
|
||||
<br />
|
||||
|
||||
@@ -95,7 +95,7 @@ This will affect the played/watched indicator. Replace the hex color with any va
|
||||
|
||||

|
||||
|
||||
### Transparant count indicators (eg. Series)
|
||||
### Transparent count indicators (eg. Series)
|
||||
|
||||
```css
|
||||
/* Make count indicator icon dark and transparent */
|
||||
@@ -736,19 +736,19 @@ Material Icons:
|
||||
- Outlined:
|
||||
|
||||
```css
|
||||
@import url("https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/Outline.css");
|
||||
@import url('https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/Outline.css');
|
||||
```
|
||||
|
||||
- Rounded:
|
||||
|
||||
```css
|
||||
@import url("https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/round.css");
|
||||
@import url('https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/round.css');
|
||||
```
|
||||
|
||||
- Sharp:
|
||||
|
||||
```css
|
||||
@import url("https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/Sharp.css");
|
||||
@import url('https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/Sharp.css');
|
||||
```
|
||||
|
||||
Fontawesome Icons:
|
||||
@@ -756,25 +756,25 @@ Fontawesome Icons:
|
||||
- Solid:
|
||||
|
||||
```css
|
||||
@import url("https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/Font%20Awesome/solid.css");
|
||||
@import url('https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/Font%20Awesome/solid.css');
|
||||
```
|
||||
|
||||
- Regular:
|
||||
|
||||
```css
|
||||
@import url("https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/Font%20Awesome/regular.css");
|
||||
@import url('https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/Font%20Awesome/regular.css');
|
||||
```
|
||||
|
||||
- Light:
|
||||
|
||||
```css
|
||||
@import url("https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/Font%20Awesome/light.css");
|
||||
@import url('https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/Font%20Awesome/light.css');
|
||||
```
|
||||
|
||||
- duotone:
|
||||
|
||||
```css
|
||||
@import url("https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/Font%20Awesome/duotone.css");
|
||||
@import url('https://cdn.jsdelivr.net/gh/prayag17/Jellyfin-Icons/Font%20Awesome/duotone.css');
|
||||
```
|
||||
|
||||
## Community Links
|
||||
|
||||
@@ -28,7 +28,7 @@ The installation method for the repository varies depending on what kind of devi
|
||||
- If prompted, enter settings and enable "Unknown Sources", then go back to the Add-on Browser
|
||||
- Select the newly downloaded file and it will be installed
|
||||
|
||||
#### "Embedded" Devices (Android TV, Firestick, and other TV Boxes)
|
||||
#### "Embedded" Devices (Android TV, FireTV Stick, and other TV Boxes)
|
||||
|
||||
1. Open Kodi, go to the settings menu, and navigate to "File manager"
|
||||
- Select "Add source"
|
||||
|
||||
@@ -43,7 +43,7 @@ When writing a bug issue, please ensure you capture as much relevant detail as p
|
||||
|
||||
Bugs should be tagged with `[bug]` at the beginning of their title. This will later be removed by the Jellyfin team when assigning labels. To assist in triaging, if you know which other [label(s)](/docs/general/contributing/issues#issue-labels) should be applied to your issue, please add them after the `[bug]` label.
|
||||
|
||||
Bugs should be reproduceable. That is, you should be able to have determined through troubleshooting how to replicate the issue. While one-time bugs should not be ignored, if they're difficult or impossible to reproduce, it's likely very hard to fix them. Please attempt to reproduce the bug before filing the issue and include the smallest test case you can to demonstrate it.
|
||||
Bugs should be reproducible. That is, you should be able to have determined through troubleshooting how to replicate the issue. While one-time bugs should not be ignored, if they're difficult or impossible to reproduce, it's likely very hard to fix them. Please attempt to reproduce the bug before filing the issue and include the smallest test case you can to demonstrate it.
|
||||
|
||||
If you ever need assistance for troubleshooting or opening an issue, please [contact the community](/docs/general/getting-help) and we'll try to help you out!
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ Steps to run Jellyfin using Podman are similar to the Docker steps.
|
||||
|
||||
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. Additionaly port 7359 UDP needs to be opened for auto discovery.
|
||||
If your distribution uses `firewalld`, the following commands save and load a new firewall rule opening the HTTP port `8096` for TCP connections. Additionally port 7359 UDP needs to be opened for auto discovery.
|
||||
|
||||
```sh
|
||||
sudo firewall-cmd --add-port=8096/tcp --permanent
|
||||
|
||||
@@ -527,7 +527,7 @@ You can also pull new images to use in the future.
|
||||
|
||||
You can choose to pull from Jellyfin's [Docker Hub](https://hub.docker.com/r/jellyfin/jellyfin) or [GitHub Container Registry](https://github.com/jellyfin/jellyfin/pkgs/container/jellyfin).
|
||||
|
||||
- To pull from Docker Hub, use: `jellyfin/jellyin`
|
||||
- To pull from Docker Hub, use: `jellyfin/jellyfin`
|
||||
- To pull from from GHCR, use: `ghcr.io/jellyfin/jellyfin`
|
||||
- [You can check this blog post for more info about GHCR:](/posts/jellyfin-release-10.9.0#key-release-notesbreaking-changes)
|
||||
- "Docker users: We now offer GitHub Container Registry (GHCR) as an alternative container registry in addition to Docker Hub. You can pull images from the new registry via URIs like `ghcr.io/jellyfin/jellyfin:latest`. Don't worry, we have no plans to drop Docker Hub as a container registry, but we feel providing both gives users more choice and flexibility."
|
||||
|
||||
@@ -8,7 +8,7 @@ sidebar_position: 3
|
||||
## Debian / Ubuntu and derivatives
|
||||
|
||||
To simplify deployment and help automate this for as many users as possible, we provide a BASH script to handle repo installation as well as installing Jellyfin on Debian / Ubuntu and derivatives.
|
||||
All you need to do is run this command on your system (requires `curl`, or subsitute `curl` with `wget -O-`):
|
||||
All you need to do is run this command on your system (requires `curl`, or substitute `curl` with `wget -O-`):
|
||||
|
||||
```sh
|
||||
curl https://repo.jellyfin.org/install-debuntu.sh | sudo bash
|
||||
|
||||
@@ -30,13 +30,13 @@ Cons:
|
||||
Setup on server:
|
||||
|
||||
1. Install the Tailscale app on the client device. Instructions are available in [Tailscale's official install guide](https://tailscale.com/kb/1347/installation)
|
||||
2. Login to the Tailscale client and connect to the tailnet. On Windows and macOS that can be done through the icon in the system tray. On Linux that can be done with the comnand `sudo tailscale up`
|
||||
2. Login to the Tailscale client and connect to the tailnet. On Windows and macOS that can be done through the icon in the system tray. On Linux that can be done with the command `sudo tailscale up`
|
||||
3. Find and note your Tailscale IP of the server according to the [Tailscale Documentation](https://tailscale.com/kb/1033/ip-and-dns-addresses?tab=linux#finding-your-tailscale-ip-address). This IP will be used for other devices to connect. The IP should start with 100 (e.g. 100.12.34.56).
|
||||
|
||||
Setup on clients:
|
||||
|
||||
1. Install the Tailscale app on the client device. Instructions are available in [Tailscale's official install guide](https://tailscale.com/kb/1347/installation)
|
||||
2. Login to the Tailscale client and connect to the tailnet. On Windows and macOS that can be done through the icon in the system tray. On Linux that can be done with the comnand `sudo tailscale up`. On mobile devices that can be done through the tailscale app.
|
||||
2. Login to the Tailscale client and connect to the tailnet. On Windows and macOS that can be done through the icon in the system tray. On Linux that can be done with the command `sudo tailscale up`. On mobile devices that can be done through the tailscale app.
|
||||
3. Type in the server IP from above into your browser or Jellyfin client of choice and connect. (e.g. 100.12.34.56:8096)
|
||||
|
||||
## Using Tailscale with a reverse proxy
|
||||
@@ -52,7 +52,7 @@ Setup on Jellyfin server:
|
||||
Setup on reverse proxy server:
|
||||
|
||||
1. Install the Tailscale app on the client device. Instructions are available in [Tailscale's official install guide](https://tailscale.com/kb/1347/installation)
|
||||
2. Login to the tailscale client and connect to the tailnet. On Linux this can be done with the comnand `sudo tailscale up`
|
||||
2. Login to the tailscale client and connect to the tailnet. On Linux this can be done with the command `sudo tailscale up`
|
||||
3. Setup a reverse proxy of your choice and set the upstream server to the IP from above. Example [Caddy](./reverse-proxy/caddy) configuration: (Assuming server has Tailscale IP of 100.12.34.56)
|
||||
|
||||
```txt
|
||||
|
||||
@@ -150,7 +150,7 @@ Replace `<upstream-server-ip>` with the actual IP address of your upstream serve
|
||||
iptables -C INPUT -j f2b-<name> 2>/dev/null || iptables -I INPUT -j f2b-<name>; \
|
||||
iptables -I f2b-<name> 1 -s <ip> -j DROP' && \
|
||||
echo "Banned <ip> from jail <name> via upstream proxy" >> /var/log/fail2ban.log
|
||||
|
||||
|
||||
# Option: actionunban
|
||||
# 1. Remove the banned IP from the dynamic chain
|
||||
# 2. Remove the chain if it becomes empty (cleanup)
|
||||
@@ -165,7 +165,7 @@ Replace `<upstream-server-ip>` with the actual IP address of your upstream serve
|
||||
echo "Unbanned <ip> from jail <name> via upstream proxy and cleaned up chain if empty" >> /var/log/fail2ban.log
|
||||
```
|
||||
|
||||
After making chaneges, save and close the file.
|
||||
After making changes, save and close the file.
|
||||
|
||||
2. **Update Fail2Ban Jails to Use the Dynamic Chain Action**:
|
||||
|
||||
@@ -195,7 +195,7 @@ Replace `<upstream-server-ip>` with the actual IP address of your upstream serve
|
||||
action = proxy-iptables-dynamic
|
||||
```
|
||||
|
||||
After making chaneges, save and close the file.
|
||||
After making changes, save and close the file.
|
||||
|
||||
### Step three: Add proxy IPs to Jellyfin
|
||||
|
||||
@@ -211,7 +211,7 @@ Replace `<upstream-server-ip>` with the actual IP address of your upstream serve
|
||||
|
||||
Open your Jellyfin server's dashboard, go to `Advanced` -> `Networking`, and then scroll down to `Known proxies`.
|
||||
|
||||
Enter your comma-seperated list of proxy IP ranges. You'll need to reboot the Jellyfin server as indicated.
|
||||
Enter your comma-separated list of proxy IP ranges. You'll need to reboot the Jellyfin server as indicated.
|
||||
|
||||
### Step four: Restart Fail2Ban and Test the Setup
|
||||
|
||||
@@ -257,7 +257,7 @@ Replace `<upstream-server-ip>` with the actual IP address of your upstream serve
|
||||
|
||||
6. **Verify Unban**:
|
||||
|
||||
Verify that the IP is removed from the corresponding jail's chain ('f2b-jail-name'):
|
||||
Verify that the IP is removed from the corresponding jail's chain ('f2b-jail-name'):
|
||||
|
||||
```bash
|
||||
ssh root@<upstream-server-ip> "iptables -L f2b-jellyfin"
|
||||
|
||||
@@ -16,24 +16,24 @@ Neither does Jellyfin require an internet connection to run; however you should
|
||||
|
||||
This section aims to provide an administrator with knowledge on what ports Jellyfin binds to and what purpose they serve.
|
||||
|
||||
| Port | Protocol | Configurable | Description |
|
||||
|---|---|---|---|
|
||||
| 8096 | TCP | ✔️ | Default HTTP |
|
||||
| 8920 | TCP | ✔️ | Default HTTPS |
|
||||
| 7359 | UDP | ❌ | Client Discovery |
|
||||
| Port | Protocol | Configurable | Description |
|
||||
| ---- | -------- | ------------ | ---------------- |
|
||||
| 8096 | TCP | ✔️ | Default HTTP |
|
||||
| 8920 | TCP | ✔️ | Default HTTPS |
|
||||
| 7359 | UDP | ❌ | Client Discovery |
|
||||
|
||||
<details>
|
||||
<summary>See details</summary>
|
||||
|
||||
- **HTTP Traffic** (8096/TCP):
|
||||
The web frontend can be accessed here. You can modify this setting from the **Networking** page in the admin settings.
|
||||
The web frontend can be accessed here. You can modify this setting from the **Networking** page in the admin settings.
|
||||
|
||||
- **HTTPS Traffic** (8920/TCP):
|
||||
Used when https is enabled. By default this port will not be used.
|
||||
This setting can also be modified from the **Networking** page to use a different port.
|
||||
Used when https is enabled. By default this port will not be used.
|
||||
This setting can also be modified from the **Networking** page to use a different port.
|
||||
|
||||
- **Client Discovery** (7359/UDP):
|
||||
Allows clients to discover Jellyfin on the local network. A broadcast message to this port will return detailed information about your server that includes name, ip-address and ID.
|
||||
Allows clients to discover Jellyfin on the local network. A broadcast message to this port will return detailed information about your server that includes name, ip-address and ID.
|
||||
|
||||
</details>
|
||||
|
||||
@@ -67,18 +67,18 @@ Opening a port directly to the Internet is therefore insecure and not recommende
|
||||
|
||||
There are different layers where a firewall can be placed:
|
||||
|
||||
| Layer | Example | Description |
|
||||
| --- | --- | --- |
|
||||
| Local | Docker, VM | Open ports at this layer to allow traffic from the Host to enter the Application |
|
||||
| Host | physical machine, operating system | Open ports at this layer to allow traffic from the Network to enter the Host device |
|
||||
| Network | Router | Open ports at this layer to allow traffic from the Internet to enter the Local Network |
|
||||
| Layer | Example | Description |
|
||||
| ------- | ---------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| Local | Docker, VM | Open ports at this layer to allow traffic from the Host to enter the Application |
|
||||
| Host | physical machine, operating system | Open ports at this layer to allow traffic from the Network to enter the Host device |
|
||||
| Network | Router | Open ports at this layer to allow traffic from the Internet to enter the Local Network |
|
||||
|
||||
<details>
|
||||
<summary>Port forwarding vs. opening a Port</summary>
|
||||
|
||||
Whilst Routers often allow you to forward a port, firewalls typically only allow you to open one.
|
||||
The difference is within the Target. Opening a Port essentially just means that traffic on this Port will go through.
|
||||
Forwarding a Port you typically do in NAT scenarios - traffic is coming in on your public IP Address, what device inside your network should recieve it.
|
||||
Forwarding a Port you typically do in NAT scenarios - traffic is coming in on your public IP Address, what device inside your network should receive it.
|
||||
Sometimes, port forwarding also lets you map an external port to a different internal port.
|
||||
|
||||
</details>
|
||||
|
||||
@@ -38,13 +38,11 @@ Hardware accelerated HDR/DV to SDR tone-mapping is supported on **all AMD GPUs t
|
||||
There are two different methods that can be used on Windows and/or Linux. Pros and cons are listed below:
|
||||
|
||||
1. **OpenCL**
|
||||
|
||||
- Pros - Supports Dolby Vision P5, detailed fine-tuning options, widely supported hardware.
|
||||
|
||||
- Cons - Zero-copy is not supported on Linux.
|
||||
|
||||
2. **Vulkan**
|
||||
|
||||
- Pros - Supports Dolby Vision P5, libplacebo renderer, ROCm OpenCL runtime is not required.
|
||||
|
||||
- Cons - Linux only, zero-copy only supports Polaris+ GPUs.
|
||||
@@ -113,7 +111,7 @@ Encoding speed and quality:
|
||||
|
||||
## Windows Setups
|
||||
|
||||
Windows 10 64-bit and newer is recommeded. **AMF is not available in Windows Docker and WSL/WSL2.**
|
||||
Windows 10 64-bit and newer is recommended. **AMF is not available in Windows Docker and WSL/WSL2.**
|
||||
|
||||
### Known Issues And Limitations On Windows
|
||||
|
||||
@@ -126,7 +124,6 @@ Please refer to [this section](./known-issues.md#amd-on-windows) for known issue
|
||||
2. Clean install the latest driver from [AMD Drivers and Support](https://www.amd.com/en/support).
|
||||
|
||||
3. Don't allow the GPU to be preempted by the Windows Remote desktop session.
|
||||
|
||||
- Type `gpedit.msc` in Win+R shortcut key dialog and run to open the "Local Group Policy Editor".
|
||||
|
||||
- Navigate in the left tree **[Computer Configuration > Administrative Templates > Windows Components]**
|
||||
@@ -154,7 +151,6 @@ Please refer to [this section](./known-issues.md#amd-on-windows) for known issue
|
||||
Duplicate engine names indicate the GPU may have multiple video engines.
|
||||
|
||||
:::
|
||||
|
||||
- **3D** - 2D/3D engine or GPGPU workload
|
||||
|
||||
- **Copy** - Blitter/Copy engine workload
|
||||
@@ -311,7 +307,6 @@ Root permission is required.
|
||||
```
|
||||
|
||||
2. User mode Mesa drivers are required to be manually installed for VA-API and RADV Vulkan:
|
||||
|
||||
- [libva-mesa-driver](https://archlinux.org/packages/extra/x86_64/libva-mesa-driver/)
|
||||
|
||||
- [vulkan-radeon](https://archlinux.org/packages/extra/x86_64/vulkan-radeon/)
|
||||
@@ -404,7 +399,6 @@ Root permission is required.
|
||||
```
|
||||
|
||||
2. Use Docker command line **or** docker compose:
|
||||
|
||||
- Example command line:
|
||||
|
||||
```shell
|
||||
@@ -486,7 +480,6 @@ Root permission is required.
|
||||
:::
|
||||
|
||||
1. Install the `radeontop` package. The name varies between distros.
|
||||
|
||||
- On Debian & Ubuntu:
|
||||
|
||||
```shell
|
||||
|
||||
@@ -99,13 +99,13 @@ lshw -C display
|
||||
|
||||
See the table below to pick the best hardware acceleration method for your hardware:
|
||||
|
||||
| GPU Vendor | Windows | macOS | Linux |
|
||||
| ---------- | ------------------------------------------ | -------------------------- | -------------------------------------- |
|
||||
| GPU Vendor | Windows | macOS | Linux |
|
||||
| ---------- | --------------------------------------------- | -------------------------- | ----------------------------------------- |
|
||||
| AMD | [AMF (Windows)](./amd.md#windows-setups) | [VideoToolbox](./apple.md) | [VAAPI (AMD)](./amd.md#linux-setups) |
|
||||
| Apple | N/A | [VideoToolbox](./apple.md) | N/A |
|
||||
| Apple | N/A | [VideoToolbox](./apple.md) | N/A |
|
||||
| Intel | [QSV (Windows)](./intel.md#windows-setups) | [VideoToolbox](./apple.md) | [QSV (Linux)](./intel.md#linux-setups) |
|
||||
| Nvidia | [NVENC (Windows)](./nvidia.md#windows-setups) | N/A | [NVENC (Linux)](./nvidia.md#linux-setups) |
|
||||
| Rockchip | N/A | N/A | [RKMPP](./rockchip.md) |
|
||||
| Rockchip | N/A | N/A | [RKMPP](./rockchip.md) |
|
||||
|
||||
## Remote Hardware Acceleration
|
||||
|
||||
@@ -127,7 +127,7 @@ Dolby Vision (P5 & P8) to SDR tone-mapping is supported in Jellyfin 10.8 and req
|
||||
|
||||
- Intel VPP HDR10 tone-mapping is supported on Intel QSV and VA-API on Linux.
|
||||
|
||||
- VPP is prefered if both tone-mapping options are enabled.
|
||||
- VPP is preferred if both tone-mapping options are enabled.
|
||||
|
||||
- Rockchip RKMPP does support Dolby Vision tone-mapping Jellyfin 10.11 and later versions.
|
||||
|
||||
|
||||
@@ -54,13 +54,11 @@ Hardware accelerated HDR/DV to SDR tone-mapping is supported on **all Intel GPUs
|
||||
There are two different methods that can be used on Windows and/or Linux. Pros and cons are listed below:
|
||||
|
||||
1. **OpenCL**
|
||||
|
||||
- Pros - Supports Dolby Vision P5, detailed fine-tuning options, widely supported hardware.
|
||||
|
||||
- Cons - The OpenCL runtime sometimes need to be manually installed on Linux.
|
||||
|
||||
2. **QSV VPP**
|
||||
|
||||
- Pros - Lower power consumption, realized by Intel fixed-function LUT hardware.
|
||||
|
||||
- Cons - Poor tuning options, limited supported GPU models, **currently only available on Linux**.
|
||||
@@ -205,7 +203,7 @@ You only need to follow the [Windows Setups](./intel.md#windows-setups) and [Lin
|
||||
|
||||
## Windows Setups
|
||||
|
||||
Windows 10 64-bit and newer is recommeded. **QSV is not available on Windows Docker and WSL/WSL2.**
|
||||
Windows 10 64-bit and newer is recommended. **QSV is not available on Windows Docker and WSL/WSL2.**
|
||||
|
||||
### Known Issues And Limitations On Windows
|
||||
|
||||
@@ -218,7 +216,6 @@ Please refer to [this section](/docs/general/post-install/transcoding/hardware-a
|
||||
2. Clean install the latest EXE or INF driver from [Intel download center](https://www.intel.com/content/www/us/en/download-center/home.html).
|
||||
|
||||
3. Don't allow the GPU to be preempted by the Windows Remote desktop session.
|
||||
|
||||
- Type `gpedit.msc` in Win+R shortcut key dialog and run to open the "Local Group Policy Editor".
|
||||
|
||||
- Navigate in the left tree **[Computer Configuration > Administrative Templates > Windows Components]**
|
||||
@@ -246,7 +243,6 @@ Please refer to [this section](/docs/general/post-install/transcoding/hardware-a
|
||||
Duplicate engine names indicate the GPU may have multiple MFX video engines.
|
||||
|
||||
:::
|
||||
|
||||
- **3D** - 2D/3D engine, QSV VPP or GPGPU workload
|
||||
|
||||
- **Copy** - Blitter/Copy engine workload
|
||||
@@ -349,7 +345,6 @@ Root permission is required.
|
||||
7. Check the supported QSV / VA-API codecs:
|
||||
|
||||
:::note
|
||||
|
||||
- `iHD driver` indicates support for the QSV and VA-API interfaces.
|
||||
|
||||
- `i965 driver` indicates only support for the VA-API interface, which should only be used on pre-Broadwell platforms.
|
||||
@@ -407,7 +402,6 @@ Root permission is required.
|
||||
```
|
||||
|
||||
2. User mode Intel media drivers and the OpenCL runtime are required to be manually installed for enabling QSV / VA-API:
|
||||
|
||||
- [intel-media-driver](https://archlinux.org/packages/extra/x86_64/intel-media-driver/)
|
||||
|
||||
- [intel-media-sdk](https://archlinux.org/packages/extra/x86_64/intel-media-sdk/)
|
||||
@@ -496,7 +490,6 @@ What you need to do is pass the host's `render` group id to Docker and modify th
|
||||
```
|
||||
|
||||
2. Use docker command line **or** docker compose:
|
||||
|
||||
- Example command line:
|
||||
|
||||
```shell
|
||||
@@ -565,7 +558,7 @@ This follows the same principles as for the Docker, with one small change that y
|
||||
|
||||
The devices in Kubernetes are added as host path mounts, they are not separated into separate volumes like in the Docker example.
|
||||
|
||||
1. Example Kubernetes (API version 1) configuraton file written in YAML:
|
||||
1. Example Kubernetes (API version 1) configuration file written in YAML:
|
||||
|
||||
```yaml
|
||||
# Example of an incomplete deployment spec
|
||||
@@ -635,7 +628,7 @@ This has been tested with LXC 3.0 and may or may not work with older versions.
|
||||
lxc config device add <CONTAINER_NAME> gpu gpu gid=<GID_OF_HOST_RENDER_GROUP>
|
||||
```
|
||||
|
||||
4. Make sure you have the requied devices within the container:
|
||||
4. Make sure you have the required devices within the container:
|
||||
|
||||
```shell
|
||||
$ lxc exec jellyfin -- ls -l /dev/dri
|
||||
@@ -668,7 +661,6 @@ This has been tested with LXC 3.0 and may or may not work with older versions.
|
||||
**Proxmox VE 7 or Older**:
|
||||
|
||||
:::note
|
||||
|
||||
- Jellyfin needs to run in a **privileged** LXC container.
|
||||
|
||||
- An existing unprivileged container can be converted to a privileged container by taking a backup and restoring it as privileged.
|
||||
@@ -706,7 +698,6 @@ Root permission is required.
|
||||
:::
|
||||
|
||||
1. Install the `intel-gpu-tools` package **on the host system**, which is used for debugging Intel graphics driver on Linux. The name varies between distros.
|
||||
|
||||
- On Debian & Ubuntu:
|
||||
|
||||
```shell
|
||||
@@ -728,7 +719,6 @@ Root permission is required.
|
||||
Duplicate engine names indicate the GPU may have multiple MFX video engines.
|
||||
|
||||
:::
|
||||
|
||||
- **Render/3D** - 2D/3D engine, QSV VPP or GPGPU workload
|
||||
|
||||
- **Blitter** - Blitter/Copy engine workload
|
||||
@@ -816,7 +806,6 @@ Root permission is required.
|
||||
:::
|
||||
|
||||
1. Install the latest linux firmware packages **on the host system**. The name varies between distros.
|
||||
|
||||
- On Debian:
|
||||
|
||||
```shell
|
||||
@@ -845,7 +834,6 @@ Root permission is required.
|
||||
```
|
||||
|
||||
2. Add the required i915 kernel parameter on the host system to enable loading GuC and HuC firmware:
|
||||
|
||||
- Check the kernel module in use, goto step 3 if **xe** kernel driver is in use.
|
||||
|
||||
:::note
|
||||
@@ -879,7 +867,6 @@ Root permission is required.
|
||||
```
|
||||
|
||||
3. Update the initramfs and grub. The commands varies between distros.
|
||||
|
||||
- On Debian & Ubuntu:
|
||||
|
||||
```shell
|
||||
|
||||
@@ -16,7 +16,6 @@ This page lists all known issues and limitations of hardware acceleration with J
|
||||
1. Some Linux distros intentionally disabled the H.264 and HEVC codecs from the Mesa VA-API driver.
|
||||
|
||||
Known affected distros:
|
||||
|
||||
- [Fedora](https://www.phoronix.com/news/Fedora-Disable-Bad-VA-API)
|
||||
|
||||
- [OpenSUSE](https://www.webpronews.com/fedora-and-opensuse-disable-gpu-accelerated-video-over-patent-concerns/)
|
||||
@@ -40,11 +39,9 @@ This page lists all known issues and limitations of hardware acceleration with J
|
||||
## Intel on Linux
|
||||
|
||||
1. Intel Gen 11 [**Jasper Lake**](https://ark.intel.com/content/www/us/en/ark/products/codename/128823/products-formerly-jasper-lake.html) and [**Elkhart Lake**](https://ark.intel.com/content/www/us/en/ark/products/codename/128825/products-formerly-elkhart-lake.html) platforms (e.g. N5095, N5105, N6005, J6412) have quirks when using video encoders on Linux. The [Low-Power Encoding](./intel.md#low-power-encoding) mode MUST be configured and enabled for correct VBR and CBR bitrate control that is required by Jellyfin.
|
||||
|
||||
- Ticket: [https://gitlab.freedesktop.org/drm/intel/-/issues/8080](https://gitlab.freedesktop.org/drm/intel/-/issues/8080)
|
||||
|
||||
2. The default kernel 5.15 that comes with Ubuntu 22.04 LTS has a regression on Intel Gen 11 graphics (ICL, JSL and EHL) that prevents you from using the Low-Power encoding mode. Linux 5.16+ is not affected.
|
||||
|
||||
- Ticket: [https://gitlab.freedesktop.org/drm/intel/-/issues/4067](https://gitlab.freedesktop.org/drm/intel/-/issues/4067)
|
||||
|
||||
- Fixed by: [drm/i915/gen11: Moving WAs to icl_gt_workarounds_init()](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=52255ef662a5d490678fbad64a735f88fcba564d)
|
||||
@@ -58,7 +55,6 @@ This page lists all known issues and limitations of hardware acceleration with J
|
||||
This will move you off a 5.15 kernel which could have other implications. If it breaks something you can return to the normal kernel by installing the linux-generic package.
|
||||
|
||||
3. The kernel range from 5.18 to 6.1.3 have an issue that locks up and resets the i915 kernel driver when using OpenCL based HDR/DV tone-mapping. Linux 5.18-, 6.0.18+, 6.1.4+ are not affected.
|
||||
|
||||
- Ticket: [https://gitlab.freedesktop.org/drm/intel/-/issues/7627](https://gitlab.freedesktop.org/drm/intel/-/issues/7627)
|
||||
|
||||
- Fixed by: [drm/i915: improve the catch-all evict to handle lock contention](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3f882f2d4f689627c1566c2c92087bc3ff734953)
|
||||
@@ -80,7 +76,6 @@ This page lists all known issues and limitations of hardware acceleration with J
|
||||
11. The kernel support for Intel Gen 13 (or Gen 20?) LNL and BMG / ARC B-series are incomplete before Linux 6.12.
|
||||
|
||||
12. The LTS kernel range 6.6.26 - 6.6.32 and the stable kernel range 6.8.5 - 6.9.3 have i915 driver bugs, which may cause problems on Intel Gen 12.5 DG2 / ARC A-series GPUs. If you are affected, please upgrade to kernel 6.6.33+ (LTS) or 6.9.4+. Ubuntu 24.04 with kernel versions 6.8.0-38 thru 6.8.0-41 are also affected by this issue. Upgrade to Ubuntu kernel 6.8.0-44+ if you are on the affected kernels.
|
||||
|
||||
- Issue: [https://github.com/jellyfin/jellyfin/issues/11380](https://github.com/jellyfin/jellyfin/issues/11380)
|
||||
- Ubuntu bug: [https://bugs.launchpad.net/ubuntu/+source/linux/+bug/2072755](https://bugs.launchpad.net/ubuntu/+source/linux/+bug/2072755)
|
||||
|
||||
@@ -88,7 +83,7 @@ This page lists all known issues and limitations of hardware acceleration with J
|
||||
|
||||
14. Resizable-BAR is mandatory for hardware acceleration on BMG / ARC B-series cards, or the [media driver will crash the transcoder](https://github.com/intel/media-driver/issues/1893).
|
||||
|
||||
15. Intel Compute-Runtime currently uses LLVM 14 for compilation [as seen on the Intel bug report page](https://github.com/intel/intel-graphics-compiler/issues/289), making it unavailable in some distibutions like Debian Trixie [as seen on the Debian bug report page](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1072376). Intel provided releases [on the Intel GitHub page](https://github.com/intel/compute-runtime/releases) which only require matching a matching libc runtime may be used instead.
|
||||
15. Intel Compute-Runtime currently uses LLVM 14 for compilation [as seen on the Intel bug report page](https://github.com/intel/intel-graphics-compiler/issues/289), making it unavailable in some distributions like Debian Trixie [as seen on the Debian bug report page](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1072376). Intel provided releases [on the Intel GitHub page](https://github.com/intel/compute-runtime/releases) which only require matching a matching libc runtime may be used instead.
|
||||
|
||||
## Nvidia
|
||||
|
||||
@@ -106,4 +101,4 @@ This page lists all known issues and limitations of hardware acceleration with J
|
||||
- [https://github.com/ollama/ollama/issues/6928#issuecomment-2586208913](https://github.com/ollama/ollama/issues/6928#issuecomment-2586208913)
|
||||
3. Docker desktop isn't supported by Nvidia Container Toolkit.
|
||||
- [https://github.com/NVIDIA/nvidia-container-toolkit/issues/219#issuecomment-1903941381](https://github.com/NVIDIA/nvidia-container-toolkit/issues/219#issuecomment-1903941381)
|
||||
If you need a GUI, use the docker package and podman, or similar.
|
||||
If you need a GUI, use the docker package and podman, or similar.
|
||||
|
||||
@@ -67,7 +67,7 @@ Maxwell+ GPUs provide support for HEVC:
|
||||
|
||||
:::note
|
||||
|
||||
Note that in Maxwell 2nd Gen series only the GM206 variants provide HEVC 10-bit decoding support. Its sucessor Pascal has full support for HEVC 10-bit and improved speed and quality.
|
||||
Note that in Maxwell 2nd Gen series only the GM206 variants provide HEVC 10-bit decoding support. Its successor Pascal has full support for HEVC 10-bit and improved speed and quality.
|
||||
|
||||
:::
|
||||
|
||||
@@ -113,7 +113,7 @@ NVENC/NVDEC performance tables:
|
||||
|
||||
## Windows Setups
|
||||
|
||||
Windows 10 64-bit and newer is recommeded. **In Jellyfin 10.10 the minimum required NVIDIA driver version is 522.25**.
|
||||
Windows 10 64-bit and newer is recommended. **In Jellyfin 10.10 the minimum required NVIDIA driver version is 522.25**.
|
||||
|
||||
### Configure On Windows Host
|
||||
|
||||
@@ -136,7 +136,6 @@ Refer to [Configure On Linux Host](./nvidia.md#configure-on-linux-host) and [Con
|
||||
2. Open the "Task Manager" and navigate to the GPU page.
|
||||
|
||||
3. Check the occupancy of the engines as follows.
|
||||
|
||||
- **3D** - 2D/3D engine or CUDA/GPGPU workload
|
||||
|
||||
- **Copy** - Blitter/Copy engine workload
|
||||
@@ -176,7 +175,6 @@ Root permission is required.
|
||||
```
|
||||
|
||||
3. Install the NVIDIA proprietary driver by following these links. Then install two extra packages for NVENC and NVDEC support:
|
||||
|
||||
- On Debian: [https://wiki.debian.org/NvidiaGraphicsDrivers](https://wiki.debian.org/NvidiaGraphicsDrivers)
|
||||
|
||||
```shell
|
||||
@@ -237,7 +235,6 @@ Root permission is required.
|
||||
```
|
||||
|
||||
2. Install the NVIDIA proprietary driver by following the link. Then install an extra package for NVENC and NVDEC support:
|
||||
|
||||
- [https://wiki.archlinux.org/title/NVIDIA#Installation](https://wiki.archlinux.org/title/NVIDIA#Installation)
|
||||
|
||||
```shell
|
||||
@@ -310,11 +307,9 @@ Root permission is required.
|
||||
1. Install the NVIDIA proprietary driver on the host system. See above instructions.
|
||||
|
||||
2. Install the NVIDIA Container Toolkit on the host system by following this link:
|
||||
|
||||
- [https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#installation-guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#installation-guide)
|
||||
|
||||
3. Use the Docker command line **or** docker-compose:
|
||||
|
||||
- Example command line:
|
||||
|
||||
```shell
|
||||
@@ -355,7 +350,7 @@ Root permission is required.
|
||||
|
||||
:::note
|
||||
|
||||
If you encounter the upsteam issue `CUDA_ERROR_NO_DEVICE: no CUDA-capable device is detected`, pass these extra devices to the Docker:
|
||||
If you encounter the upstream issue `CUDA_ERROR_NO_DEVICE: no CUDA-capable device is detected`, pass these extra devices to the Docker:
|
||||
|
||||
```shell
|
||||
/dev/nvidia-caps:/dev/nvidia-caps
|
||||
@@ -464,7 +459,7 @@ The paths of Jellyfin config and data folders in the official and LSIO Docker im
|
||||
--environment=JELLYFIN_CONFIG_DIR=/etc/jellyfin
|
||||
--environment=JELLYFIN_LOG_DIR=/var/log/jellyfin
|
||||
--environment=JELLYFIN_CACHE_DIR=/var/cache/jellyfin
|
||||
--volume=/your/path/to/data:/var/lib/jellyfin # Replace paths with actual paths on your host's filestystem
|
||||
--volume=/your/path/to/data:/var/lib/jellyfin # Replace paths with actual paths on your host's filesystem
|
||||
--volume=/your/path/to/config:/etc/jellyfin
|
||||
--volume=/your/path/to/logs:/var/log/jellyfin
|
||||
--volume=/your/path/to/cache:/var/cache/jellyfin
|
||||
@@ -477,7 +472,7 @@ The paths of Jellyfin config and data folders in the official and LSIO Docker im
|
||||
```sh
|
||||
[Unit]
|
||||
Description=jellyfin
|
||||
|
||||
|
||||
[Container]
|
||||
Image=docker.io/jellyfin/jellyfin:latest
|
||||
AutoUpdate=registry
|
||||
@@ -489,7 +484,7 @@ The paths of Jellyfin config and data folders in the official and LSIO Docker im
|
||||
Environment=JELLYFIN_CONFIG_DIR=/etc/jellyfin
|
||||
Environment=JELLYFIN_LOG_DIR=/var/log/jellyfin
|
||||
Environment=JELLYFIN_CACHE_DIR=/var/cache/jellyfin
|
||||
Volume=/your/path/to/data:/var/lib/jellyfin # Replace paths with actual paths on your host's filestystem
|
||||
Volume=/your/path/to/data:/var/lib/jellyfin # Replace paths with actual paths on your host's filesystem
|
||||
Volume=/your/path/to/config:/etc/jellyfin
|
||||
Volume=/your/path/to/logs:/var/log/jellyfin
|
||||
Volume=/your/path/to/cache:/var/cache/jellyfin
|
||||
@@ -497,10 +492,10 @@ The paths of Jellyfin config and data folders in the official and LSIO Docker im
|
||||
[Service]
|
||||
# Inform systemd of additional exit status
|
||||
SuccessExitStatus=0 143
|
||||
|
||||
|
||||
[Install]
|
||||
# Start by default on boot
|
||||
WantedBy=default.target
|
||||
WantedBy=default.target
|
||||
```
|
||||
|
||||
5. Create the following udev rule to make sure the GPU devices are initialized before the container is started.
|
||||
|
||||
@@ -155,7 +155,6 @@ Root permission is required.
|
||||
Only needed before using HDR tone-mapping on RK3588/3588S. This is done to ensure that the user space firmware and kernel driver versions match, otherwise OpenCL will not work properly.
|
||||
|
||||
:::
|
||||
|
||||
- For the 6.1 LTS kernel on [Ubuntu-Rockchip](https://github.com/Joshua-Riek/ubuntu-rockchip) & [Armbian](https://github.com/armbian) and the legacy 5.10 LTS kernel, install [v1.9-1-2131373](https://github.com/tsukumijima/libmali-rockchip/releases/download/v1.9-1-2131373/libmali-valhall-g610-g24p0-gbm_1.9-1_arm64.deb).
|
||||
|
||||
- For the 6.1 LTS kernel on other SBC **vendor-made** distros, install [v1.9-1-55611b0](https://github.com/tsukumijima/libmali-rockchip/releases/download/v1.9-1-55611b0/libmali-valhall-g610-g13p0-gbm_1.9-1_arm64.deb).
|
||||
@@ -193,7 +192,7 @@ Root permission is required.
|
||||
|
||||
:::
|
||||
|
||||
1. Use Docker command line: (the extensive device names between `for...done` is used to ensure backward compatiblity)
|
||||
1. Use Docker command line: (the extensive device names between `for...done` is used to ensure backward compatibility)
|
||||
|
||||
```shell
|
||||
sudo docker run -d \
|
||||
@@ -233,7 +232,7 @@ Root permission is required.
|
||||
|
||||
#### LXC (Linux Containers)
|
||||
|
||||
This setup might be useful for those, who use RK3588/3588S SoC as [Proxmox](https://www.proxmox.com/en/) host, where LXC is the official and the only supported way of doing lightweight virtualiztion with the help of system containers (LXC) vs application containers (docker). As of today Proxmox team does not support ARM platforms as hosts - and probably will never do - however successful deployments on ARM devices [are possible](https://github.com/jiangcuo/Proxmox-Port?tab=readme-ov-file).
|
||||
This setup might be useful for those, who use RK3588/3588S SoC as [Proxmox](https://www.proxmox.com/en/) host, where LXC is the official and the only supported way of doing lightweight virtualization with the help of system containers (LXC) vs application containers (docker). As of today Proxmox team does not support ARM platforms as hosts - and probably will never do - however successful deployments on ARM devices [are possible](https://github.com/jiangcuo/Proxmox-Port?tab=readme-ov-file).
|
||||
|
||||
LXC setup idea is a bit similar to docker - you need to pass the **device files** of VPU from host to LXC and enable the **privileged mode** (see also important "_note_" below about privileged LXC containers).
|
||||
|
||||
@@ -251,7 +250,7 @@ LXC setup idea is a bit similar to docker - you need to pass the **device files*
|
||||
device /dev/mpp_service
|
||||
```
|
||||
|
||||
Example of the minumum requried extra (not full) container configuration to make VPU hardware accelearion working is presented below:
|
||||
Example of the minimum required extra (not full) container configuration to make VPU hardware acceleration working is presented below:
|
||||
|
||||
```shell
|
||||
lxc.mount.entry: /dev/dri dev/dri none bind,optional,create=dir
|
||||
@@ -273,7 +272,6 @@ LXC setup idea is a bit similar to docker - you need to pass the **device files*
|
||||
|
||||
2. Install supported [jellyfin package](https://jellyfin.org/docs/general/installation/linux) into LXC container or optionally you can even use an official docker image inside LXC container.
|
||||
3. Verify OpenCL runtime status as following - example is collected from LXC runtime of Ubuntu Jammy - steps are the same as docker deployments:
|
||||
|
||||
- _libmali user-space drivers should be installed inside LXC container, otherwise opencl=ocl@rk device won't be initialized_
|
||||
|
||||
```shell
|
||||
|
||||
@@ -61,33 +61,33 @@ Image types:
|
||||
|
||||
<sup>1</sup>Multiple backdrop images can be used to cycle through several over time. Simply append a number to the end of the filename directly after or after a hyphen, e.g. `backdrop-1.jpg`, `backdrop2.jpg`.
|
||||
|
||||
<sup>2</sup>These can be added to both video and audio content, but are not used by any client for audio conent.
|
||||
<sup>2</sup>These can be added to both video and audio content, but are not used by any client for audio content.
|
||||
|
||||
<details>
|
||||
<summary>Filenames, their respective types and supported media types</summary>
|
||||
|
||||
Unless otherwise noted, all filenames can be used either standalone (e.g. `logo.png`) or as a suffix (e.g. `movie-logo.png`)
|
||||
|
||||
| Filename | Type | Movies | Series | Season | Episode | Music | Artist |
|
||||
| ------------------------ | --------- | --------------- | ------ | ------ | ------- | ----- | ------ |
|
||||
| poster | Primary | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| folder | Primary | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | ✅ |
|
||||
| cover | Primary | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| default | Primary | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| movie | Primary | ✅ <sup>2</sup> | | | | | |
|
||||
| show | Primary | | ✅ | | | | |
|
||||
| jacket | Primary | | | | | ✅ | |
|
||||
| thumb (suffix) <sup>1</sup> | Primary | | | | ✅ | | |
|
||||
| backdrop | Backdrop | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| fanart | Backdrop | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| background | Backdrop | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| art | Backdrop | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| extrafanart (folder) | Backdrop | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| banner | Banner | ✅ | ✅ | ✅ | | ✅ | |
|
||||
| logo | Logo | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| clearlogo | Logo | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| landscape | Thumb | ✅ | ✅ | ✅ | | ✅ | |
|
||||
| thumb | Thumb | ✅ | ✅ | ✅ | | ✅ | |
|
||||
| Filename | Type | Movies | Series | Season | Episode | Music | Artist |
|
||||
| --------------------------- | -------- | --------------- | ------ | ------ | ------- | ----- | ------ |
|
||||
| poster | Primary | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| folder | Primary | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | ✅ |
|
||||
| cover | Primary | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| default | Primary | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| movie | Primary | ✅ <sup>2</sup> | | | | | |
|
||||
| show | Primary | | ✅ | | | | |
|
||||
| jacket | Primary | | | | | ✅ | |
|
||||
| thumb (suffix) <sup>1</sup> | Primary | | | | ✅ | | |
|
||||
| backdrop | Backdrop | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| fanart | Backdrop | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| background | Backdrop | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| art | Backdrop | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| extrafanart (folder) | Backdrop | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| banner | Banner | ✅ | ✅ | ✅ | | ✅ | |
|
||||
| logo | Logo | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| clearlogo | Logo | ✅ <sup>2</sup> | ✅ | ✅ | | ✅ | |
|
||||
| landscape | Thumb | ✅ | ✅ | ✅ | | ✅ | |
|
||||
| thumb | Thumb | ✅ | ✅ | ✅ | | ✅ | |
|
||||
|
||||
<sup>1</sup> For example: `S01E01 Some Episode-thumb.jpg` <br />
|
||||
<sup>2</sup> These file names can also be embedded in supported media containers (e.g. mkv) and will be used when the `Embedded Image Extractor` source is enabled for movies.
|
||||
|
||||
@@ -17,10 +17,10 @@ There are more official providers available in our [Plugin Catalog](/docs/genera
|
||||
|
||||
:::caution Notice for Users in Mainland China 中国大陆地区用户请注意
|
||||
|
||||
Because of external factors, certain metadata providers may not be accessable in mainland China. <br />
|
||||
Because of external factors, certain metadata providers may not be accessible in mainland China. <br />
|
||||
由于外部因素,部分元数据提供者在中国大陆地区可能无法访问。
|
||||
|
||||
Below is a list of known inaccessable providers: <br />
|
||||
Below is a list of known inaccessible providers: <br />
|
||||
下方为已知无法访问的提供者:
|
||||
|
||||
- The Movie Database (TMDb)
|
||||
|
||||
@@ -37,54 +37,54 @@ It's currently not possible to disable .nfo metadata. Local metadata will always
|
||||
User data importing is only possible for a single user. This user can be set in the .nfo settings.
|
||||
:::
|
||||
|
||||
| Tag | Note |
|
||||
| ------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| name | |
|
||||
| title | same as name |
|
||||
| localtitle | same as name |
|
||||
| dateadded | |
|
||||
| originaltitle | |
|
||||
| sortname | |
|
||||
| criticrating | |
|
||||
| sorttitle | |
|
||||
| plot | |
|
||||
| biography | same as plot |
|
||||
| review | same as plot |
|
||||
| language | |
|
||||
| watched | please see the note about user data |
|
||||
| playcount | please see the note about user data |
|
||||
| lastplayed | please see the note about user data |
|
||||
| countrycode | |
|
||||
| lockedfields | |
|
||||
| tagline | |
|
||||
| country | |
|
||||
| mpaa | |
|
||||
| customrating | |
|
||||
| runtime | |
|
||||
| aspectratio | |
|
||||
| lockdata | |
|
||||
| studio | multiple tags allowed |
|
||||
| director | multiple tags allowed |
|
||||
| credits | multiple tags allowed |
|
||||
| writer | multiple tags allowed |
|
||||
| actor | multiple tags allowed |
|
||||
| trailer | kodi format |
|
||||
| displayorder | |
|
||||
| year | |
|
||||
| rating | same as customrating |
|
||||
| ratings | multiple child tags allowed; name attribute of each tag will specify wheter the rating is critics or community rating |
|
||||
| aired | |
|
||||
| formed | |
|
||||
| premiered | |
|
||||
| releasedate | |
|
||||
| enddate | |
|
||||
| genre | multiple tags allowed. These tags will be ignored for music albums and music artists. |
|
||||
| tag | multiple tags allowed |
|
||||
| style | multiple tags allowed |
|
||||
| fileinfo | |
|
||||
| uniqueid | type attribute specifies id provider |
|
||||
| thumb | please see the [section about images](#image-paths-and-urls-in-nfo-files) |
|
||||
| fanart | please see the [section about images](#image-paths-and-urls-in-nfo-files) |
|
||||
| Tag | Note |
|
||||
| ------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||
| name | |
|
||||
| title | same as name |
|
||||
| localtitle | same as name |
|
||||
| dateadded | |
|
||||
| originaltitle | |
|
||||
| sortname | |
|
||||
| criticrating | |
|
||||
| sorttitle | |
|
||||
| plot | |
|
||||
| biography | same as plot |
|
||||
| review | same as plot |
|
||||
| language | |
|
||||
| watched | please see the note about user data |
|
||||
| playcount | please see the note about user data |
|
||||
| lastplayed | please see the note about user data |
|
||||
| countrycode | |
|
||||
| lockedfields | |
|
||||
| tagline | |
|
||||
| country | |
|
||||
| mpaa | |
|
||||
| customrating | |
|
||||
| runtime | |
|
||||
| aspectratio | |
|
||||
| lockdata | |
|
||||
| studio | multiple tags allowed |
|
||||
| director | multiple tags allowed |
|
||||
| credits | multiple tags allowed |
|
||||
| writer | multiple tags allowed |
|
||||
| actor | multiple tags allowed |
|
||||
| trailer | kodi format |
|
||||
| displayorder | |
|
||||
| year | |
|
||||
| rating | same as customrating |
|
||||
| ratings | multiple child tags allowed; name attribute of each tag will specify whether the rating is critics or community rating |
|
||||
| aired | |
|
||||
| formed | |
|
||||
| premiered | |
|
||||
| releasedate | |
|
||||
| enddate | |
|
||||
| genre | multiple tags allowed. These tags will be ignored for music albums and music artists. |
|
||||
| tag | multiple tags allowed |
|
||||
| style | multiple tags allowed |
|
||||
| fileinfo | |
|
||||
| uniqueid | type attribute specifies id provider |
|
||||
| thumb | please see the [section about images](#image-paths-and-urls-in-nfo-files) |
|
||||
| fanart | please see the [section about images](#image-paths-and-urls-in-nfo-files) |
|
||||
|
||||
Provider id tags are supported as well if they follow the scheme: `<PROVIDER_NAME`+ `id>`.
|
||||
|
||||
@@ -99,7 +99,7 @@ Jellyfin can write metadata to .nfo files. To enable this option, select the "Nf
|
||||
| .nfo tag | Note |
|
||||
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
||||
| title | |
|
||||
| id | IMDb id for movies, TVDb id for tv shows, |
|
||||
| id | IMDb id for movies, TVDb id for tv shows, |
|
||||
| originaltitle | |
|
||||
| seasonnumber | only for tv show seasons |
|
||||
| showtitle | only for tv show episodes |
|
||||
|
||||
@@ -25,7 +25,7 @@ The objective of the guide is to configure the Jellyfin TVHeadend plugin to back
|
||||
- Change parameters: Rights,Channel number range,Channel tags,DVR configurations,Streaming profiles,Connection limits
|
||||
- Web interface: ✔
|
||||
- Streaming: Basic,Advanced,HTSP
|
||||
- Video recoder: Basic,HTSP,View all
|
||||
- Video recorder: Basic,HTSP,View all
|
||||
- (Optional) Comment: Comment for the user (for example: User used by Jellyfin)
|
||||
- (Optional) Allowed networks: _Network address with network mask to allow_ (for example 127.0.0.1/32)
|
||||
- Press Save
|
||||
@@ -38,7 +38,7 @@ The objective of the guide is to configure the Jellyfin TVHeadend plugin to back
|
||||
|
||||
:::note
|
||||
|
||||
The parameters Change parameters, Streaming and Video recoder must be marked as shown. Otherwise, Jellyfin can connect to TVHeadend but problems may arise when reproducing the content.
|
||||
The parameters Change parameters, Streaming and Video recorder must be marked as shown. Otherwise, Jellyfin can connect to TVHeadend but problems may arise when reproducing the content.
|
||||
|
||||
:::
|
||||
|
||||
@@ -56,7 +56,6 @@ By default the the _TVHeadend Hostname or IP Address_ section is configured by d
|
||||
:::
|
||||
|
||||
3. Configure the channels for viewing in Jellyfin: even if Jellyfin manages to connect to TVHeadend, the guide will not be synchronized because there has to be a number assigned to the channels in TVHeadend. [Reference](https://emby.media/community/index.php?/topic/64583-no-channels-with-tvheadend-plugin/#entry642268)
|
||||
|
||||
- Manual mode
|
||||
- Go to Configuration > Channel/EPG > Channels
|
||||
- Select the channel to be changed and press Edit
|
||||
|
||||
@@ -11,7 +11,7 @@ Note: If your media files are unavailable when the `Clean up collections and pla
|
||||
|
||||
## Default Jellyfin Tasks
|
||||
|
||||
Below is a list of tasks that Jellyfin runs peoridically by default:
|
||||
Below is a list of tasks that Jellyfin runs periodically by default:
|
||||
|
||||
### Libraries
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ As a general rule, "Jellyfin" should always be capitalized, but language, file,
|
||||
- C# class and project names, including their files and directories, should use capitalized `Jellyfin` as required by the C# case standards (camelCase or PascalCase). `Jellyfin.LiveTv`, `Jellyfin.sln`
|
||||
- Other code elements, where the code formatting or style requires lowercase, should use lowercase `jellyfin`. `jellyfinWebComponentsBowerPath`
|
||||
- The Git repository and non-C# files inside of it should use lowercase `jellyfin` for convenience on case-sensitive filesystems. `build-jellyfin.ps1`
|
||||
- The final output binary, initscrips, and package names should use lowercase `jellyfin` for similar reasons as above. `jellyfin.dll`, `jellyfin_3.5.2-1_all.deb`, `jellyfin.zip`
|
||||
- The final output binary, initscripts, and package names should use lowercase `jellyfin` for similar reasons as above. `jellyfin.dll`, `jellyfin_3.5.2-1_all.deb`, `jellyfin.zip`
|
||||
- Configuration directories can use either depending on operating system conventions. `/var/lib/jellyfin`, `AppData/Jellyfin`
|
||||
- The logo has no strict rules for capitalization, the style is dependent on aesthetics and font choice.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user