Skip to content

Commit f98e63e

Browse files
committed
update nvidia section of the blurb to reflect fully tested state while adding unraid specifics
1 parent 57e5578 commit f98e63e

1 file changed

Lines changed: 17 additions & 3 deletions

File tree

  • ansible/roles/documentation/templates/README_SNIPPETS

ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,24 @@ For Intel and AMD GPUs.
5454

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

57+
5758
**Note: Nvidia support is not available for Alpine-based images.**
5859

5960
**Prerequisites:**
6061

61-
1. **Driver:** Proprietary drivers **580 or higher** are required.
62-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
63-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
62+
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.**
63+
* **Unraid:** Use the production branch from the Nvidia Driver Plugin.
64+
2. **Kernel Parameter:** You must set `nvidia-drm.modeset=1` in your host bootloader.
65+
* **Standard Linux (GRUB):** Edit `/etc/default/grub` and add the parameter to your existing `GRUB_CMDLINE_LINUX_DEFAULT` line:
66+
```text
67+
GRUB_CMDLINE_LINUX_DEFAULT="<other existing options> nvidia-drm.modeset=1"
68+
```
69+
Then apply the changes by running:
70+
```bash
71+
sudo update-grub
72+
```
73+
* **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.
74+
3. **Hardware Initialization:** **On headless systems, the Nvidia video card requires a physical dummy plug inserted into the GPU so that DRM initializes properly.**
6475
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
6576

6677
```bash
@@ -88,6 +99,9 @@ services:
8899
count: 1
89100
capabilities: [compute,video,graphics,utility]
90101
```
102+
103+
* **Unraid:** Ensure you're properly setting the DRINODE/DRI_NODE and adding `--gpus all --runtime nvidia` to your extra parameters.
104+
91105
{% endif %}
92106

93107
### SealSkin Compatibility

0 commit comments

Comments
 (0)