Skip to content

update nvidia section of the blurb to reflect fully tested state while adding unraid specifics #383

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

Merged
thelamer merged 1 commit into from
Mar 20, 2026
Merged

update nvidia section of the blurb to reflect fully tested state while adding unraid specifics #383

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 17 additions & 3 deletions ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,24 @@ For Intel and AMD GPUs.

{% if show_nvidia is defined %}##### Nvidia (Proprietary Drivers)


**Note: Nvidia support is not available for Alpine-based images.**

**Prerequisites:**

1. **Driver:** Proprietary drivers **580 or higher** are required.
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
1. **Driver:** Proprietary drivers **580 or higher** are required. **Crucially, you should install the driver using the `.run` file downloaded directly from the Nvidia website.**
* **Unraid:** Use the production branch from the Nvidia Driver Plugin.
2. **Kernel Parameter:** You must set `nvidia-drm.modeset=1` in your host bootloader.
* **Standard Linux (GRUB):** Edit `/etc/default/grub` and add the parameter to your existing `GRUB_CMDLINE_LINUX_DEFAULT` line:
```text
GRUB_CMDLINE_LINUX_DEFAULT="<other existing options> nvidia-drm.modeset=1"
```
Then apply the changes by running:
```bash
sudo update-grub
```
* **Unraid (Syslinux):** Edit the file `/boot/syslinux/syslinux.cfg` and add `nvidia-drm.modeset=1` to the end of the `append` line for the Unraid OS boot entry.
3. **Hardware Initialization:** **On headless systems, the Nvidia video card requires a physical dummy plug inserted into the GPU so that DRM initializes properly.**
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:

```bash
Expand Down Expand Up @@ -88,6 +99,9 @@ services:
count: 1
capabilities: [compute,video,graphics,utility]
```

* **Unraid:** Ensure you're properly setting the DRINODE/DRI_NODE and adding `--gpus all --runtime nvidia` to your extra parameters.

{% endif %}

### SealSkin Compatibility
Expand Down