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