Skip to content

Commit 71892ff

Browse files
Bot Updating Documentation
1 parent 0b144ec commit 71892ff

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

docs/images/docker-shotcut.md

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

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

9294
##### Intel & AMD (Open Source Drivers)
9395

@@ -105,13 +107,34 @@ For Intel and AMD GPUs.
105107
106108
##### Nvidia (Proprietary Drivers)
107109
110+
**Note: Nvidia support is currently considered experimental, driver changes can break it at any time.**
111+
108112
**Note: Nvidia support is not available for Alpine-based images.**
109113
114+
**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**
115+
110116
**Prerequisites:**
111117

112-
1. **Driver:** Proprietary drivers **580 or higher** are required.
113-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
114-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
118+
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.**
119+
* **Unraid:** Use the production branch from the Nvidia Driver Plugin.
120+
121+
2. **Kernel Parameter:** You must set `nvidia-drm.modeset=1 nvidia_drm.fbdev=1` in your host bootloader.
122+
* **Standard Linux (GRUB):** Edit `/etc/default/grub` and add the parameter to your existing `GRUB_CMDLINE_LINUX_DEFAULT` line:
123+
124+
```text
125+
GRUB_CMDLINE_LINUX_DEFAULT="<other existing options> nvidia-drm.modeset=1 nvidia_drm.fbdev=1"
126+
```
127+
128+
Then apply the changes by running:
129+
130+
```bash
131+
sudo update-grub
132+
```
133+
134+
* **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.
135+
136+
3. **Hardware Initialization:** **On headless systems, the Nvidia video card requires a physical dummy plug inserted into the GPU so that DRM initializes properly.**
137+
115138
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
116139

117140
```bash
@@ -140,6 +163,8 @@ services:
140163
capabilities: [compute,video,graphics,utility]
141164
```
142165

166+
* **Unraid:** Ensure you're properly setting the DRINODE/DRI_NODE and adding `--gpus all --runtime nvidia` to your extra parameters.
167+
143168
### SealSkin Compatibility
144169

145170
This container is compatible with [SealSkin](https://sealskin.app).
@@ -159,12 +184,14 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
159184
| Variable | Description |
160185
| :----: | --- |
161186
| 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 |
187+
| SELKIES_DESKTOP | If set to true and in Wayland mode, a simple panel will be initialized with labwc |
162188
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default `3000` |
163189
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default `3001` |
164190
| CUSTOM_WS_PORT | Internal port the container listens on for websockets if it needs to be swapped from the default 8082 |
165191
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
166192
| DRI_NODE | **Encoding GPU**: Enable VAAPI/NVENC stream encoding and use the specified device IE `/dev/dri/renderD128` |
167193
| DRINODE | **Rendering GPU**: Specify which GPU to use for EGL/3D acceleration IE `/dev/dri/renderD129` |
194+
| 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` |
168195
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
169196
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
170197
| TITLE | The page title displayed on the web browser, default "Selkies" |
@@ -364,7 +391,6 @@ You can install packages from the system's native repository using the [universa
364391
| `SELKIES_ENABLE_PLAYER3` | `True` | Enable sharing link for gamepad player 3. |
365392
| `SELKIES_ENABLE_PLAYER4` | `True` | Enable sharing link for gamepad player 4. |
366393

367-
368394

369395
## Usage
370396

0 commit comments

Comments
 (0)