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: docs/images/docker-rustdesk.md
+34-5Lines changed: 34 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,6 +42,8 @@ The application can be accessed at:
42
42
43
43
*https://yourhost:3001/
44
44
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
+
45
47
### Strict reverse proxies
46
48
47
49
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
87
89
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
88
90
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
89
91
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**.
91
95
92
96
##### Intel & AMD (Open Source Drivers)
93
97
@@ -105,13 +109,34 @@ For Intel and AMD GPUs.
105
109
106
110
##### Nvidia (Proprietary Drivers)
107
111
112
+
**Note: Nvidia support is currently considered experimental, driver changes can break it at any time.**
113
+
108
114
**Note: Nvidia support is not available for Alpine-based images.**
109
115
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
+
110
118
**Prerequisites:**
111
119
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:
* **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
+
115
140
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
116
141
117
142
```bash
@@ -140,6 +165,8 @@ services:
140
165
capabilities: [compute,video,graphics,utility]
141
166
```
142
167
168
+
* **Unraid:** Ensure you're properly setting the DRINODE/DRI_NODE and adding `--gpus all --runtime nvidia` to your extra parameters.
169
+
143
170
### SealSkin Compatibility
144
171
145
172
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
159
186
| Variable | Description |
160
187
| :----: | --- |
161
188
| 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 |
162
190
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default `3000` |
163
191
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default `3001` |
164
192
| 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` |
167
195
| 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` |
168
197
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
169
198
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
170
199
| 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
364
393
| `SELKIES_ENABLE_PLAYER3` | `True` | Enable sharing link for gamepad player 3. |
365
394
| `SELKIES_ENABLE_PLAYER4` | `True` | Enable sharing link for gamepad player 4. |
366
395
367
-
368
396
369
397
## Usage
370
398
@@ -680,6 +708,7 @@ To help with development, we generate this dependency graph.
680
708
681
709
## Versions
682
710
711
+
* **04.04.26:** - Make Wayland default disable with PIXELFLUX_WAYLAND=false.
683
712
* **28.12.25:** - Add Wayland init logic.
684
713
* **22.09.25:** - Rebase to Debian Trixie.
685
714
* **12.07.25:** - Rebase to Selkies, HTTPS IS NOW REQUIRED.
0 commit comments