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-boinc.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
@@ -96,19 +96,22 @@ We are currently transitioning our desktop containers from X11 to Wayland. While
96
96
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
97
97
98
98
To enable Wayland mode, set the following environment variable:
99
-
*`-e PIXELFLUX_WAYLAND=true`
99
+
100
+
*`-e PIXELFLUX_WAYLAND=true`
100
101
101
102
**Why use Wayland?**
102
-
***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.
103
-
***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.
103
+
104
+
***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.
105
+
***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.
104
106
105
107
#### GPU Configuration
106
108
107
109
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
108
110
109
111
**Configuration Variables:**
110
-
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
111
-
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
112
+
113
+
*`DRINODE`: The path to the GPU used for **Rendering** (EGL).
114
+
*`DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
112
115
113
116
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
114
117
@@ -131,10 +134,12 @@ For Intel and AMD GPUs.
131
134
**Note: Nvidia support is not available for Alpine-based images.**
132
135
133
136
**Prerequisites:**
134
-
1. **Driver:** Proprietary drivers **580 or higher** are required.
135
-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
136
-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
137
-
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
137
+
138
+
1. **Driver:** Proprietary drivers **580 or higher** are required.
139
+
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
140
+
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
141
+
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
@@ -166,16 +172,15 @@ This container is compatible with [SealSkin](https://sealskin.app).
166
172
167
173
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.
168
174
169
-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
170
-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
171
-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
172
-
175
+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
176
+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
177
+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
173
178
174
179
### Options in all Selkies-based GUI containers
175
180
176
181
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies).
177
182
178
-
???+ note "Click to expand: Optional Environment Variables"
183
+
??? note "Click to expand: Optional Environment Variables"
179
184
180
185
| Variable | Description |
181
186
| :----: | --- |
@@ -204,15 +209,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
204
209
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
205
210
206
211
**`WATERMARK_LOCATION` Options:**
207
-
- **1**: Top Left
208
-
- **2**: Top Right
209
-
- **3**: Bottom Left
210
-
- **4**: Bottom Right
211
-
- **5**: Centered
212
-
- **6**: Animated
212
+
213
+
* **1**: Top Left
214
+
* **2**: Top Right
215
+
* **3**: Bottom Left
216
+
* **4**: Bottom Right
217
+
* **5**: Centered
218
+
* **6**: Animated
213
219
214
220
215
-
???+ note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
221
+
??? note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
216
222
217
223
| Argument | Description |
218
224
| :----: | --- |
@@ -221,7 +227,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
221
227
| `--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. |
222
228
223
229
224
-
???+ note "Click to expand: Legacy X11 Resolution & Acceleration"
230
+
??? note "Click to expand: Legacy X11 Resolution & Acceleration"
225
231
226
232
**Note:** This section applies only if you are **NOT** using `PIXELFLUX_WAYLAND=true`.
227
233
@@ -231,7 +237,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
231
237
232
238
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:
233
239
234
-
```
240
+
```bash
235
241
-e SELKIES_MANUAL_WIDTH=1920
236
242
-e SELKIES_MANUAL_HEIGHT=1080
237
243
-e MAX_RESOLUTION=1920x1080
@@ -242,16 +248,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
242
248
243
249
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
@@ -263,7 +269,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
263
269
264
270
To install an application, use the command line inside the container:
265
271
266
-
```
272
+
```bash
267
273
proot-apps install filezilla
268
274
```
269
275
@@ -281,7 +287,7 @@ You can install packages from the system's native repository using the [universa
281
287
282
288
### Advanced Configuration
283
289
284
-
???+ note "Click to expand: Hardening Options"
290
+
??? note "Click to expand: Hardening Options"
285
291
286
292
These variables can be used to lock down the desktop environment for single-application use cases or to restrict user capabilities.
287
293
@@ -303,21 +309,24 @@ You can install packages from the system's native repository using the [universa
303
309
| **`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. |
304
310
305
311
306
-
???+ note "Click to expand: Selkies Application Settings"
312
+
??? note "Click to expand: Selkies Application Settings"
307
313
308
314
Using environment variables every facet of the application can be configured.
309
315
310
316
**Booleans and Locking:**
311
317
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
312
-
* Example: `-e SELKIES_USE_CPU="true|locked"`
318
+
319
+
* Example: `-e SELKIES_USE_CPU="true|locked"`
313
320
314
321
**Enums and Lists:**
315
322
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.
316
-
* Example: `-e SELKIES_ENCODER="jpeg"`
323
+
324
+
* Example: `-e SELKIES_ENCODER="jpeg"`
317
325
318
326
**Ranges:**
319
327
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
320
-
* Example: `-e SELKIES_FRAMERATE="60"`
328
+
329
+
* Example: `-e SELKIES_FRAMERATE="60"`
321
330
322
331
**Manual Resolution Mode:**
323
332
If `SELKIES_MANUAL_WIDTH` or `SELKIES_MANUAL_HEIGHT` are set, the resolution is locked to those values.
0 commit comments