Skip to content

Commit 89a2250

Browse files
Bot Updating Templated Files
1 parent 29358ec commit 89a2250

File tree

1 file changed

+31
-4
lines changed

1 file changed

+31
-4
lines changed

README.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,9 @@ To use hardware acceleration in Wayland mode, we distinguish between the card us
107107
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
108108
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
109109

110-
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
110+
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency. If they are set to different devices one will be used for **Rendering** and one for **Encoding** with a cpu readback.
111+
112+
You can also use the environment variable `AUTO_GPU=true`, with this set the first card detected in the container (IE `/dev/dri/renderD128`) will be used and configured for **Zero Copy**.
111113

112114
##### Intel & AMD (Open Source Drivers)
113115

@@ -125,13 +127,34 @@ For Intel and AMD GPUs.
125127
126128
##### Nvidia (Proprietary Drivers)
127129
130+
**Note: Nvidia support is currently considered experimental, driver changes can break it at any time.**
131+
128132
**Note: Nvidia support is not available for Alpine-based images.**
129133
134+
**Note: Nvidia frames have issues with hardware decoders in Chromium browsers you need to navigate to `chrome://flags/#disable-accelerated-video-decode` and toggle it to `Disabled` for smooth playback**
135+
130136
**Prerequisites:**
131137

132-
1. **Driver:** Proprietary drivers **580 or higher** are required.
133-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
134-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
138+
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.**
139+
* **Unraid:** Use the production branch from the Nvidia Driver Plugin.
140+
141+
2. **Kernel Parameter:** You must set `nvidia-drm.modeset=1 nvidia_drm.fbdev=1` in your host bootloader.
142+
* **Standard Linux (GRUB):** Edit `/etc/default/grub` and add the parameter to your existing `GRUB_CMDLINE_LINUX_DEFAULT` line:
143+
144+
```text
145+
GRUB_CMDLINE_LINUX_DEFAULT="<other existing options> nvidia-drm.modeset=1 nvidia_drm.fbdev=1"
146+
```
147+
148+
Then apply the changes by running:
149+
150+
```bash
151+
sudo update-grub
152+
```
153+
154+
* **Unraid (Syslinux):** Edit the file `/boot/syslinux/syslinux.cfg` and add `nvidia-drm.modeset=1 nvidia_drm.fbdev=1` to the end of the `append` line for the Unraid OS boot entry.
155+
156+
3. **Hardware Initialization:** **On headless systems, the Nvidia video card requires a physical dummy plug inserted into the GPU so that DRM initializes properly.**
157+
135158
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
136159

137160
```bash
@@ -160,6 +183,8 @@ services:
160183
capabilities: [compute,video,graphics,utility]
161184
```
162185

186+
* **Unraid:** Ensure you're properly setting the DRINODE/DRI_NODE and adding `--gpus all --runtime nvidia` to your extra parameters.
187+
163188
### SealSkin Compatibility
164189

165190
This container is compatible with [SealSkin](https://sealskin.app).
@@ -180,12 +205,14 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
180205
| Variable | Description |
181206
| :----: | --- |
182207
| PIXELFLUX_WAYLAND | **Experimental** If set to true the container will initialize in Wayland mode running [Smithay](https://github.com/Smithay/smithay) and Labwc while enabling zero copy encoding with a GPU |
208+
| SELKIES_DESKTOP | If set to true and in Wayland mode, a simple panel will be initialized with labwc |
183209
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default `3000` |
184210
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default `3001` |
185211
| CUSTOM_WS_PORT | Internal port the container listens on for websockets if it needs to be swapped from the default 8082 |
186212
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
187213
| DRI_NODE | **Encoding GPU**: Enable VAAPI/NVENC stream encoding and use the specified device IE `/dev/dri/renderD128` |
188214
| DRINODE | **Rendering GPU**: Specify which GPU to use for EGL/3D acceleration IE `/dev/dri/renderD129` |
215+
| AUTO_GPU | If set to true and in Wayland mode, we will automatically use the first GPU available for encoding and rendering IE `/dev/dri/renderD128` |
189216
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
190217
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
191218
| TITLE | The page title displayed on the web browser, default "Selkies" |

0 commit comments

Comments
 (0)