Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update TrueNAS Scale instructions for upcoming 24.10 release #1163

Merged
merged 5 commits into from
Oct 28, 2024
Merged

Update TrueNAS Scale instructions for upcoming 24.10 release #1163

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ab42450
update TrueNAS Scale instructions for upcoming 24.10 release
p0358 Oct 22, 2024
6379c18
Fix mention of swap, since on TrueNAS forums it was rightfully pointe…
p0358 Oct 25, 2024
2886016
re-add "large"
p0358 Oct 25, 2024
0c7e452
link to known issues for Intel on Linux under "some newer Intel GPUs"
p0358 Oct 25, 2024
a17e5f0
Update container.md
p0358 Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 32 additions & 25 deletions docs/general/installation/container.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,28 +311,35 @@ SuccessExitStatus=0 143
WantedBy=default.target
```

## TrueNAS SCALE / TrueCharts

Jellyfin is available as a [TrueNAS SCALE](https://www.truenas.org/) App inside the [TrueCharts](https://www.truecharts.org/) App Catalog with direct integration into the GUI, no CLI needed. Direct support is available on the [TrueCharts Discord](https://discord.gg/tVsPTHWTtr) and the source code is available on [GitHub](https://github.com/truecharts/charts).

1. Install the TrueCharts Catalog to TrueNAS SCALE, see [website](https://truecharts.org/manual/SCALE/guides/getting-started/#adding-truecharts) for more info.

1. Go to Apps page from the top level SCALE menu
2. Select Manage Catalogs tab on the Apps page
3. Click Add Catalog
4. After reading the iXsystems notice, click Continue and enter the required information:
Name: truecharts
Repository: `https://github.com/truecharts/catalog`
Preferred Trains: `enterprise` and `stable`
Branch: main
5. Click Save and allow SCALE to refresh its catalog with TrueCharts (this may take a few minutes)

2. Click `Available Applications` and search for `Jellyfin`

3. Click `Install`, which will take you to the GUI Wizard and you'll be able to fill out the necessary info

- Server URL to publish in UDP Auto Discovery response.
- Networking, Ingress (Reverse Proxy), Security Options
- Adding Storage (for media folders) is also a standalone guide available in the [TrueCharts documentation](https://truecharts.org/manual/SCALE/guides/add-storage/). For Jellyfin the recommendation is to add storage as `Additional App Storage`

4. Click Save and once it's up and running you'll be able to click Open to access `Jellyfin`.
## TrueNAS SCALE

Jellyfin is available as a [TrueNAS SCALE](https://www.truenas.org/) App in the official app catalog with direct integration into the GUI, no CLI needed.

1. Go to Apps page from the top level SCALE menu

2. Click `Discover Apps` and search for `Jellyfin`

3. Click `Install`, which will take you to the GUI installation wizard and you'll be able to fill out the necessary info

- Published Server URL to publish in UDP Auto Discovery response
- User and Group Configuration: adjust only if needed, defaults to `568:568` which is `apps:apps` user/group
- Network Configuration
- Tick `Host Network` if DLNA is used, otherwise it's optional.
- You may optionally change the `WebUI Port` to the Jellyfin's default of `8096` if it's not occupied already by another app.
- Storage Configuraton
- For `Jellyfin Config Storage` and `Jellyfin Cache Storage`, consider mapping Host Paths for ease of backup.
- Store them on SSD storage if possible, as using HDD storage **will** lead to poor experience.
- For `Jellyfin Transcode Storage`, consider using `Temporary` or `tmpfs`
- `Temporary` places a Docker volume under your configured Apps dataset (`Apps` -> `Configuration` -> `Choose Pool`). Avoid if that's on HDD.
- `tmpfs` creates a temporary directory on the RAM. Ensure you set the limit to at least a few gigabytes and that you have considerate amount of spare memory, since TrueNAS disables swap by default. You may need to increase the limit if you have many media files streamed with transcoding at once, or transcodes might fail. Note that total memory usage may also be capped in the `Resources Configuration` section.
- If your only SSD storage is the boot drive, you may configure a Host Path mount to `/var/tmp/jellyfin_transcodes`.
- For media, add your library directories as Additional Storage.
- For hardware-accelerated transcoding, under the Resources Configuration:
- If using NVIDIA, tick `Use this GPU` under your listed GPU. If you don't see your GPU, go to `Apps` -> `Configuration` -> `Settings` -> Install NVIDIA Drivers.
- If using other vendors, tick `Passthrough available (non-NVIDIA) GPUs`.
- Then in Jellyfin UI, configure it under `Dashboard` -> `Playback` -> `Transcoding`.
- Note that some newer Intel GPUs might require a newer kernel version than provided. If that's the case for your GPU, you may consider using a VM with PCIe pass-through instead of app containers.
felix920506 marked this conversation as resolved.
Show resolved Hide resolved

p0358 marked this conversation as resolved.
Show resolved Hide resolved
4. Click `Install` and once it's up and running you'll be able to click `Web UI` button to access `Jellyfin`.

Additional documentation is available on [TrueNAS Documentation Hub](https://www.truenas.com/docs/truenasapps/communityapps/jellyfin/).