Skip to content

Commit 96c1c53

Browse files
Bot Updating Documentation
1 parent ffe484e commit 96c1c53

1 file changed

Lines changed: 48 additions & 39 deletions

File tree

docs/images/docker-boinc.md

Lines changed: 48 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -96,19 +96,22 @@ We are currently transitioning our desktop containers from X11 to Wayland. While
9696
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
9797

9898
To enable Wayland mode, set the following environment variable:
99-
* `-e PIXELFLUX_WAYLAND=true`
99+
100+
* `-e PIXELFLUX_WAYLAND=true`
100101

101102
**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.
104106

105107
#### GPU Configuration
106108

107109
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
108110

109111
**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).
112115

113116
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
114117

@@ -131,10 +134,12 @@ For Intel and AMD GPUs.
131134
**Note: Nvidia support is not available for Alpine-based images.**
132135
133136
**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:
142+
138143
```bash
139144
sudo nvidia-ctk runtime configure --runtime=docker
140145
sudo systemctl restart docker
@@ -143,6 +148,7 @@ For Intel and AMD GPUs.
143148
**Compose Configuration:**
144149

145150
```yaml
151+
---
146152
services:
147153
boinc:
148154
image: lscr.io/linuxserver/boinc:latest
@@ -166,16 +172,15 @@ This container is compatible with [SealSkin](https://sealskin.app).
166172

167173
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.
168174

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)
173178

174179
### Options in all Selkies-based GUI containers
175180

176181
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies).
177182

178-
???+ note "Click to expand: Optional Environment Variables"
183+
??? note "Click to expand: Optional Environment Variables"
179184

180185
| Variable | Description |
181186
| :----: | --- |
@@ -204,15 +209,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
204209
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
205210

206211
**`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
213219

214220

215-
???+ note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
221+
??? note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
216222

217223
| Argument | Description |
218224
| :----: | --- |
@@ -221,7 +227,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
221227
| `--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. |
222228

223229

224-
???+ note "Click to expand: Legacy X11 Resolution & Acceleration"
230+
??? note "Click to expand: Legacy X11 Resolution & Acceleration"
225231

226232
**Note:** This section applies only if you are **NOT** using `PIXELFLUX_WAYLAND=true`.
227233

@@ -231,7 +237,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
231237

232238
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:
233239

234-
```
240+
```bash
235241
-e SELKIES_MANUAL_WIDTH=1920
236242
-e SELKIES_MANUAL_HEIGHT=1080
237243
-e MAX_RESOLUTION=1920x1080
@@ -242,16 +248,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
242248

243249
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
244250

245-
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
246-
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
247-
* `-e LC_ALL=ko_KR.UTF-8` - Korean
248-
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
249-
* `-e LC_ALL=ru_RU.UTF-8` - Russian
250-
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
251-
* `-e LC_ALL=de_DE.UTF-8` - German
252-
* `-e LC_ALL=fr_FR.UTF-8` - French
253-
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
254-
* `-e LC_ALL=it_IT.UTF-8` - Italian
251+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
252+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
253+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
254+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
255+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
256+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
257+
* `-e LC_ALL=de_DE.UTF-8` - German
258+
* `-e LC_ALL=fr_FR.UTF-8` - French
259+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
260+
* `-e LC_ALL=it_IT.UTF-8` - Italian
255261

256262
### Application Management
257263

@@ -263,7 +269,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
263269

264270
To install an application, use the command line inside the container:
265271

266-
```
272+
```bash
267273
proot-apps install filezilla
268274
```
269275

@@ -281,7 +287,7 @@ You can install packages from the system's native repository using the [universa
281287

282288
### Advanced Configuration
283289

284-
???+ note "Click to expand: Hardening Options"
290+
??? note "Click to expand: Hardening Options"
285291

286292
These variables can be used to lock down the desktop environment for single-application use cases or to restrict user capabilities.
287293

@@ -303,21 +309,24 @@ You can install packages from the system's native repository using the [universa
303309
| **`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. |
304310

305311

306-
???+ note "Click to expand: Selkies Application Settings"
312+
??? note "Click to expand: Selkies Application Settings"
307313

308314
Using environment variables every facet of the application can be configured.
309315

310316
**Booleans and Locking:**
311317
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"`
313320

314321
**Enums and Lists:**
315322
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"`
317325

318326
**Ranges:**
319327
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"`
321330

322331
**Manual Resolution Mode:**
323332
If `SELKIES_MANUAL_WIDTH` or `SELKIES_MANUAL_HEIGHT` are set, the resolution is locked to those values.

0 commit comments

Comments
 (0)