Skip to content

Commit cb9776c

Browse files
Bot Updating Documentation
1 parent 3cee29f commit cb9776c

1 file changed

Lines changed: 34 additions & 5 deletions

File tree

docs/images/docker-rustdesk.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ The application can be accessed at:
4242

4343
* https://yourhost:3001/
4444

45+
**Note: This is the Desktop application in a web accessible format! This container is for running the client in a sandbox so it does not have access to your system. It is not a server solution!**
46+
4547
### Strict reverse proxies
4648

4749
This image uses a self-signed certificate by default. This naturally means the scheme is `https`.
@@ -87,7 +89,9 @@ To use hardware acceleration in Wayland mode, we distinguish between the card us
8789
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
8890
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
8991

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

9296
##### Intel & AMD (Open Source Drivers)
9397

@@ -105,13 +109,34 @@ For Intel and AMD GPUs.
105109
106110
##### Nvidia (Proprietary Drivers)
107111
112+
**Note: Nvidia support is currently considered experimental, driver changes can break it at any time.**
113+
108114
**Note: Nvidia support is not available for Alpine-based images.**
109115
116+
**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**
117+
110118
**Prerequisites:**
111119

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

117142
```bash
@@ -140,6 +165,8 @@ services:
140165
capabilities: [compute,video,graphics,utility]
141166
```
142167

168+
* **Unraid:** Ensure you're properly setting the DRINODE/DRI_NODE and adding `--gpus all --runtime nvidia` to your extra parameters.
169+
143170
### SealSkin Compatibility
144171

145172
This container is compatible with [SealSkin](https://sealskin.app).
@@ -159,12 +186,14 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
159186
| Variable | Description |
160187
| :----: | --- |
161188
| 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 |
189+
| SELKIES_DESKTOP | If set to true and in Wayland mode, a simple panel will be initialized with labwc |
162190
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default `3000` |
163191
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default `3001` |
164192
| CUSTOM_WS_PORT | Internal port the container listens on for websockets if it needs to be swapped from the default 8082 |
165193
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
166194
| DRI_NODE | **Encoding GPU**: Enable VAAPI/NVENC stream encoding and use the specified device IE `/dev/dri/renderD128` |
167195
| DRINODE | **Rendering GPU**: Specify which GPU to use for EGL/3D acceleration IE `/dev/dri/renderD129` |
196+
| 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` |
168197
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
169198
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
170199
| TITLE | The page title displayed on the web browser, default "Selkies" |
@@ -364,7 +393,6 @@ You can install packages from the system's native repository using the [universa
364393
| `SELKIES_ENABLE_PLAYER3` | `True` | Enable sharing link for gamepad player 3. |
365394
| `SELKIES_ENABLE_PLAYER4` | `True` | Enable sharing link for gamepad player 4. |
366395

367-
368396

369397
## Usage
370398

@@ -680,6 +708,7 @@ To help with development, we generate this dependency graph.
680708

681709
## Versions
682710

711+
* **04.04.26:** - Make Wayland default disable with PIXELFLUX_WAYLAND=false.
683712
* **28.12.25:** - Add Wayland init logic.
684713
* **22.09.25:** - Rebase to Debian Trixie.
685714
* **12.07.25:** - Rebase to Selkies, HTTPS IS NOW REQUIRED.

0 commit comments

Comments
 (0)