Skip to content

Commit dd6e459

Browse files
Bot Updating Documentation
1 parent dd3fde3 commit dd6e459

1 file changed

Lines changed: 31 additions & 5 deletions

File tree

docs/images/docker-steam.md

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

133-
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
133+
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.
134+
135+
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**.
134136

135137
##### Intel & AMD (Open Source Drivers)
136138

@@ -148,13 +150,34 @@ For Intel and AMD GPUs.
148150
149151
##### Nvidia (Proprietary Drivers)
150152
153+
**Note: Nvidia support is currently considered experimental, driver changes can break it at any time.**
154+
151155
**Note: Nvidia support is not available for Alpine-based images.**
152156
157+
**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**
158+
153159
**Prerequisites:**
154160

155-
1. **Driver:** Proprietary drivers **580 or higher** are required.
156-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
157-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
161+
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.**
162+
* **Unraid:** Use the production branch from the Nvidia Driver Plugin.
163+
164+
2. **Kernel Parameter:** You must set `nvidia-drm.modeset=1 nvidia_drm.fbdev=1` in your host bootloader.
165+
* **Standard Linux (GRUB):** Edit `/etc/default/grub` and add the parameter to your existing `GRUB_CMDLINE_LINUX_DEFAULT` line:
166+
167+
```text
168+
GRUB_CMDLINE_LINUX_DEFAULT="<other existing options> nvidia-drm.modeset=1 nvidia_drm.fbdev=1"
169+
```
170+
171+
Then apply the changes by running:
172+
173+
```bash
174+
sudo update-grub
175+
```
176+
177+
* **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.
178+
179+
3. **Hardware Initialization:** **On headless systems, the Nvidia video card requires a physical dummy plug inserted into the GPU so that DRM initializes properly.**
180+
158181
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
159182

160183
```bash
@@ -183,6 +206,8 @@ services:
183206
capabilities: [compute,video,graphics,utility]
184207
```
185208

209+
* **Unraid:** Ensure you're properly setting the DRINODE/DRI_NODE and adding `--gpus all --runtime nvidia` to your extra parameters.
210+
186211
### SealSkin Compatibility
187212

188213
This container is compatible with [SealSkin](https://sealskin.app).
@@ -202,12 +227,14 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
202227
| Variable | Description |
203228
| :----: | --- |
204229
| 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 |
230+
| SELKIES_DESKTOP | If set to true and in Wayland mode, a simple panel will be initialized with labwc |
205231
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default `3000` |
206232
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default `3001` |
207233
| CUSTOM_WS_PORT | Internal port the container listens on for websockets if it needs to be swapped from the default 8082 |
208234
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
209235
| DRI_NODE | **Encoding GPU**: Enable VAAPI/NVENC stream encoding and use the specified device IE `/dev/dri/renderD128` |
210236
| DRINODE | **Rendering GPU**: Specify which GPU to use for EGL/3D acceleration IE `/dev/dri/renderD129` |
237+
| 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` |
211238
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
212239
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
213240
| TITLE | The page title displayed on the web browser, default "Selkies" |
@@ -407,7 +434,6 @@ You can install packages from the system's native repository using the [universa
407434
| `SELKIES_ENABLE_PLAYER3` | `True` | Enable sharing link for gamepad player 3. |
408435
| `SELKIES_ENABLE_PLAYER4` | `True` | Enable sharing link for gamepad player 4. |
409436

410-
411437

412438
## Usage
413439

0 commit comments

Comments
 (0)