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-cura.md
+48-39Lines changed: 48 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,19 +72,22 @@ We are currently transitioning our desktop containers from X11 to Wayland. While
72
72
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
73
73
74
74
To enable Wayland mode, set the following environment variable:
75
-
*`-e PIXELFLUX_WAYLAND=true`
75
+
76
+
*`-e PIXELFLUX_WAYLAND=true`
76
77
77
78
**Why use Wayland?**
78
-
***Zero Copy Encoding:** When configured correctly with a GPU, the frame is rendered and encoded on the video card without ever being copied to the system RAM. This drastically lowers CPU usage and latency.
79
-
***Modern Stack:** Single-application containers utilize **Labwc** (replacing Openbox) and full desktop containers use **KDE Plasma Wayland**, providing a more modern and secure compositing environment while retaining the same user experience.
79
+
80
+
***Zero Copy Encoding:** When configured correctly with a GPU, the frame is rendered and encoded on the video card without ever being copied to the system RAM. This drastically lowers CPU usage and latency.
81
+
***Modern Stack:** Single-application containers utilize **Labwc** (replacing Openbox) and full desktop containers use **KDE Plasma Wayland**, providing a more modern and secure compositing environment while retaining the same user experience.
80
82
81
83
#### GPU Configuration
82
84
83
85
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
84
86
85
87
**Configuration Variables:**
86
-
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
87
-
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
88
+
89
+
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
90
+
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
88
91
89
92
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
90
93
@@ -107,10 +110,12 @@ For Intel and AMD GPUs.
107
110
**Note: Nvidia support is not available for Alpine-based images.**
108
111
109
112
**Prerequisites:**
110
-
1. **Driver:** Proprietary drivers **580 or higher** are required.
111
-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
112
-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
113
-
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
113
+
114
+
1. **Driver:** Proprietary drivers **580 or higher** are required.
115
+
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
116
+
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
117
+
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
@@ -142,16 +148,15 @@ This container is compatible with [SealSkin](https://sealskin.app).
142
148
143
149
SealSkin is a self-hosted, client-server platform that provides secure authentication and collaboration features while using a browser extension to intercept user actions such as clicking a link or downloading a file and redirect them to a secure, isolated application environment running on a remote server.
144
150
145
-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
146
-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
147
-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
148
-
151
+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
152
+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
153
+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
149
154
150
155
### Options in all Selkies-based GUI containers
151
156
152
157
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies).
153
158
154
-
???+ note "Click to expand: Optional Environment Variables"
159
+
??? note "Click to expand: Optional Environment Variables"
155
160
156
161
| Variable | Description |
157
162
| :----: | --- |
@@ -180,15 +185,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
180
185
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
181
186
182
187
**`WATERMARK_LOCATION` Options:**
183
-
- **1**: Top Left
184
-
- **2**: Top Right
185
-
- **3**: Bottom Left
186
-
- **4**: Bottom Right
187
-
- **5**: Centered
188
-
- **6**: Animated
188
+
189
+
* **1**: Top Left
190
+
* **2**: Top Right
191
+
* **3**: Bottom Left
192
+
* **4**: Bottom Right
193
+
* **5**: Centered
194
+
* **6**: Animated
189
195
190
196
191
-
???+ note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
197
+
??? note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
192
198
193
199
| Argument | Description |
194
200
| :----: | --- |
@@ -197,7 +203,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
197
203
| `--device /dev/dri:/dev/dri` | Mount a GPU into the container, this can be used in conjunction with the `DRINODE` environment variable to leverage a host video card for GPU accelerated applications. |
198
204
199
205
200
-
???+ note "Click to expand: Legacy X11 Resolution & Acceleration"
206
+
??? note "Click to expand: Legacy X11 Resolution & Acceleration"
201
207
202
208
**Note:** This section applies only if you are **NOT** using `PIXELFLUX_WAYLAND=true`.
203
209
@@ -207,7 +213,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
207
213
208
214
This will set the total virtual framebuffer to 4K. By default, the virtual monitor is 16K. If you have performance issues in an accelerated X11 session, try clamping the resolution to 1080p and work up from there:
209
215
210
-
```
216
+
```bash
211
217
-e SELKIES_MANUAL_WIDTH=1920
212
218
-e SELKIES_MANUAL_HEIGHT=1080
213
219
-e MAX_RESOLUTION=1920x1080
@@ -218,16 +224,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
218
224
219
225
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
@@ -239,7 +245,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
239
245
240
246
To install an application, use the command line inside the container:
241
247
242
-
```
248
+
```bash
243
249
proot-apps install filezilla
244
250
```
245
251
@@ -257,7 +263,7 @@ You can install packages from the system's native repository using the [universa
257
263
258
264
### Advanced Configuration
259
265
260
-
???+ note "Click to expand: Hardening Options"
266
+
??? note "Click to expand: Hardening Options"
261
267
262
268
These variables can be used to lock down the desktop environment for single-application use cases or to restrict user capabilities.
263
269
@@ -279,21 +285,24 @@ You can install packages from the system's native repository using the [universa
279
285
| **`RESTART_APP`** | If true, enables a watchdog service that automatically restarts the main application if it is closed. The user's autostart script is made read-only and root owned to prevent tampering. |
280
286
281
287
282
-
???+ note "Click to expand: Selkies Application Settings"
288
+
??? note "Click to expand: Selkies Application Settings"
283
289
284
290
Using environment variables every facet of the application can be configured.
285
291
286
292
**Booleans and Locking:**
287
293
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
288
-
* Example: `-e SELKIES_USE_CPU="true|locked"`
294
+
295
+
* Example: `-e SELKIES_USE_CPU="true|locked"`
289
296
290
297
**Enums and Lists:**
291
298
These settings accept a comma-separated list of values. The first item becomes default. If only one item is provided, the UI dropdown is hidden.
292
-
* Example: `-e SELKIES_ENCODER="jpeg"`
299
+
300
+
* Example: `-e SELKIES_ENCODER="jpeg"`
293
301
294
302
**Ranges:**
295
303
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
296
-
* Example: `-e SELKIES_FRAMERATE="60"`
304
+
305
+
* Example: `-e SELKIES_FRAMERATE="60"`
297
306
298
307
**Manual Resolution Mode:**
299
308
If `SELKIES_MANUAL_WIDTH` or `SELKIES_MANUAL_HEIGHT` are set, the resolution is locked to those values.
0 commit comments