Add documentation for Truenas Scale Electric Eel (v24.10) #1228
Conversation
|
You should remove this part https://jellyfin.org/docs/general/installation/container#truenas-scale |
Done. |
Cloudflare Pages deployment
|
There was a problem hiding this comment.
Few points:
- Replace
It'swithIt isat the beginning of sentences - Use relative links to link to other parts of the docs
- Remove this section of the docs https://jellyfin.org/docs/general/installation/container#truenas-scale
| - Jellyfin can be installed on iX-systems' [TrueNAS SCALE](https://www.truenas.com/truenas-scale/). | ||
| - This documentation is written for TrueNAS SCALE v24.10.0 (Electric Eel) or higher. | ||
| - Consider reviewing the [TrueNAS Apps documentation](https://www.truenas.com/docs/truenasapps/) if you have not previously configured applications on your system. | ||
|
|
There was a problem hiding this comment.
This shouldn't be a list. Also, should clarify that Truenas Core is different not supported
| 2. Community 3rd Party App provided by ix-systems | ||
|
|
||
| Both methods use the official Jellyfin-provided Docker image. | ||
| This documentation will cover both install methods. |
There was a problem hiding this comment.
| This documentation will cover both install methods. | |
| This document will cover both install methods. |
|
|
||
| You can configure environment variables at any time after deploying the application. | ||
|
|
||
| It's recommend to set the TrueNAS SCALE App system to a storage pool comprised of SSDs. |
There was a problem hiding this comment.
| It's recommend to set the TrueNAS SCALE App system to a storage pool comprised of SSDs. | |
| It is recommend to set the TrueNAS SCALE App system to a storage pool comprised of SSDs. |
| 3. config/transcodes | ||
|
|
||
| If you use the community app, you can allow SCALE to create datasets for the directories Jellyfin requires automatically during app installation. | ||
| You can also choose to create a static **transcodes** dataset or use temporary storage on the disk or in memory (system RAM) for transcoding. |
There was a problem hiding this comment.
Please tell users using ram is not a good idea as it can easily run out and cause transcodes to fail. SSD is recommended as using HDD might cause slowdowns
| You can also [create your own custom datasets](https://www.truenas.com/docs/scale/scaletutorials/storage/datasets/datasetsscale/) to use in the **Storage Configuration** section as `host paths` during installation. | ||
|
|
||
| You can organize datasets as one parent with two child datasets, for example `/mnt/tank/jellyfin/config`, `/mnt/tank/jellyfin/cache`, and so on. | ||
| With Docker, you can organzie these in any way as long as you mount them under the correct name to the Docker container. |
There was a problem hiding this comment.
| With Docker, you can organzie these in any way as long as you mount them under the correct name to the Docker container. | |
| With Docker, you can organize these in any way as long as you mount them under the correct name to the Docker container. |
| ### Networking Settings | ||
|
|
||
| Select **Host Network** under **Network Configuration** if using [DLNA](/docs/general/networking/dlna/), to bind network configuration to the host network settings. | ||
| Otherwise, leave **Host Network** unselected. | ||
|
|
||
|  | ||
|
|
||
| You can accept the default port number in **WebUI Port**, which is **30013**. | ||
|
|
||
| You can change this to port **8096**. | ||
| Most Jellyfin clients have built-in scanning features that look for port **8096** by default. | ||
|
|
||
| Refer to the TrueNAS [default port list](https://www.truenas.com/docs/references/defaultports/) for a list of assigned port numbers. |
There was a problem hiding this comment.
the auto discovery ports should also be configured if possible https://jellyfin.org/docs/general/networking/#static-ports
| 2. Jellyfin Cache Storage | ||
| 3. Jellyfin Transcodes Storage | ||
|
|
||
| Solid state storage is recommended for config and cache storage. |
There was a problem hiding this comment.
transcodes should also use SSD
| You can customize limits on the CPU and memory allocated to the container Jellyfin will reside in. | ||
|
|
||
| - **CPUs** expects a value in **number of threads** to assign as a max CPU thread limit. | ||
| - The default is **2** which means the container will use 2 CPU threads at most. |
There was a problem hiding this comment.
2 is asking for trouble. Should just tell users to set it to number of threads their CPU has
| ## NVIDIA GPUs on SCALE (v24.10+) | ||
|
|
||
| - For users with an NVIDIA GPU, [read the v24.10 Electric Eel release notes regarding your GPU:](https://www.truenas.com/docs/scale/24.10/gettingstarted/scalereleasenotes/#upgrade-notes) | ||
| - `"Starting in 24.10, TrueNAS does not include a default NVIDIA GPU driver and instead provides a simple NVIDIA driver download option in the web interface. This allows for driver updates between TrueNAS release versions."` | ||
| - `"Users can enable driver installation from the Installed applications screen. Click Configure > Settings and select Install NVIDIA Drivers. This option is only available for users with a compatible NVIDIA GPU and no drivers installed or for users who have previously enabled the setting."` |
There was a problem hiding this comment.
Please add instructions on how to setup HWA on Intel and AMD on Truenas scale
There was a problem hiding this comment.
Do you mean adding instructions for how to do so within the Jellyfin dashboard?
If not, unless it's adding drivers manually to Scale, this is not needed.
For the Scale app launcher GUI, all you need to do to pass the Intel and AMD GPUs to the container is to click on the GPU option on the bottom of the launcher as shown in the document.
I also provided commented YAML lines for the same HWA passthrough.
This specific block is added because Scale no longer packages the NVIDIA GPU drivers and users need to install them separately using some built-in options in Scale.
| With Docker, you can organzie these in any way as long as you mount them under the correct name to the Docker container. | ||
|
|
||
| It's recommended to set Jellyfin's config directory to an accessible dataset. | ||
| This will make it easy to [backup/restore your server](https://jellyfin.org/docs/general/administration/backup-and-restore). |
There was a problem hiding this comment.
use a relative link
| This will make it easy to [backup/restore your server](https://jellyfin.org/docs/general/administration/backup-and-restore). | |
| This will make it easy to [backup/restore your server](/docs/general/administration/backup-and-restore). |
joshuaboniface
changed the title
I started working on this PR by modifying another PR, but after not having seen progress on it after I submitted my PR to it, I decided to submit again here.
The original PR credit goes to this user.
Here's a detailed list of changes from their PR compared to what I added/changed.