You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-4Lines changed: 31 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,7 +105,9 @@ To use hardware acceleration in Wayland mode, we distinguish between the card us
105
105
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
106
106
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
107
107
108
-
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
108
+
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.
109
+
110
+
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**.
109
111
110
112
##### Intel & AMD (Open Source Drivers)
111
113
@@ -123,13 +125,34 @@ For Intel and AMD GPUs.
123
125
124
126
##### Nvidia (Proprietary Drivers)
125
127
128
+
**Note: Nvidia support is currently considered experimental, driver changes can break it at any time.**
129
+
126
130
**Note: Nvidia support is not available for Alpine-based images.**
127
131
132
+
**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**
133
+
128
134
**Prerequisites:**
129
135
130
-
1. **Driver:** Proprietary drivers **580 or higher** are required.
131
-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
132
-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
136
+
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.**
137
+
* **Unraid:** Use the production branch from the Nvidia Driver Plugin.
138
+
139
+
2. **Kernel Parameter:** You must set `nvidia-drm.modeset=1 nvidia_drm.fbdev=1` in your host bootloader.
140
+
* **Standard Linux (GRUB):** Edit `/etc/default/grub` and add the parameter to your existing `GRUB_CMDLINE_LINUX_DEFAULT` line:
* **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.
153
+
154
+
3. **Hardware Initialization:** **On headless systems, the Nvidia video card requires a physical dummy plug inserted into the GPU so that DRM initializes properly.**
155
+
133
156
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
134
157
135
158
```bash
@@ -158,6 +181,8 @@ services:
158
181
capabilities: [compute,video,graphics,utility]
159
182
```
160
183
184
+
* **Unraid:** Ensure you're properly setting the DRINODE/DRI_NODE and adding `--gpus all --runtime nvidia` to your extra parameters.
185
+
161
186
### SealSkin Compatibility
162
187
163
188
This container is compatible with [SealSkin](https://sealskin.app).
@@ -178,12 +203,14 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
178
203
| Variable | Description |
179
204
| :----: | --- |
180
205
| 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 |
206
+
| SELKIES_DESKTOP | If set to true and in Wayland mode, a simple panel will be initialized with labwc |
181
207
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default `3000` |
182
208
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default `3001` |
183
209
| CUSTOM_WS_PORT | Internal port the container listens on for websockets if it needs to be swapped from the default 8082 |
| DRI_NODE | **Encoding GPU**: Enable VAAPI/NVENC stream encoding and use the specified device IE `/dev/dri/renderD128` |
186
212
| DRINODE | **Rendering GPU**: Specify which GPU to use for EGL/3D acceleration IE `/dev/dri/renderD129` |
213
+
| 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` |
187
214
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
188
215
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
189
216
| TITLE | The page title displayed on the web browser, default "Selkies" |
0 commit comments