Skip to content

Commit 2ab05a6

Browse files
Bot Updating Documentation
1 parent 6657f55 commit 2ab05a6

1 file changed

Lines changed: 41 additions & 35 deletions

File tree

docs/images/docker-pidgin.md

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

9494
To enable Wayland mode, set the following environment variable:
95-
* `-e PIXELFLUX_WAYLAND=true`
95+
96+
* `-e PIXELFLUX_WAYLAND=true`
9697

9798
**Why use Wayland?**
98-
* **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.
99-
* **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.
99+
100+
* **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.
101+
* **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.
100102

101103
#### GPU Configuration
102104

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

105107
**Configuration Variables:**
106-
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
107-
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
108+
109+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
110+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
108111

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

@@ -129,16 +132,15 @@ This container is compatible with [SealSkin](https://sealskin.app).
129132
130133
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.
131134
132-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
133-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
134-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
135-
135+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
136+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
137+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
136138
137139
### Options in all Selkies-based GUI containers
138140
139141
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies).
140142
141-
???+ note "Click to expand: Optional Environment Variables"
143+
??? note "Click to expand: Optional Environment Variables"
142144
143145
| Variable | Description |
144146
| :----: | --- |
@@ -167,15 +169,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
167169
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
168170

169171
**`WATERMARK_LOCATION` Options:**
170-
- **1**: Top Left
171-
- **2**: Top Right
172-
- **3**: Bottom Left
173-
- **4**: Bottom Right
174-
- **5**: Centered
175-
- **6**: Animated
172+
173+
* **1**: Top Left
174+
* **2**: Top Right
175+
* **3**: Bottom Left
176+
* **4**: Bottom Right
177+
* **5**: Centered
178+
* **6**: Animated
176179

177180

178-
???+ note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
181+
??? note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
179182

180183
| Argument | Description |
181184
| :----: | --- |
@@ -184,7 +187,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
184187
| `--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. |
185188

186189

187-
???+ note "Click to expand: Legacy X11 Resolution & Acceleration"
190+
??? note "Click to expand: Legacy X11 Resolution & Acceleration"
188191

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

@@ -194,7 +197,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
194197

195198
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:
196199

197-
```
200+
```bash
198201
-e SELKIES_MANUAL_WIDTH=1920
199202
-e SELKIES_MANUAL_HEIGHT=1080
200203
-e MAX_RESOLUTION=1920x1080
@@ -205,16 +208,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
205208

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

208-
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
209-
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
210-
* `-e LC_ALL=ko_KR.UTF-8` - Korean
211-
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
212-
* `-e LC_ALL=ru_RU.UTF-8` - Russian
213-
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
214-
* `-e LC_ALL=de_DE.UTF-8` - German
215-
* `-e LC_ALL=fr_FR.UTF-8` - French
216-
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
217-
* `-e LC_ALL=it_IT.UTF-8` - Italian
211+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
212+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
213+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
214+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
215+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
216+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
217+
* `-e LC_ALL=de_DE.UTF-8` - German
218+
* `-e LC_ALL=fr_FR.UTF-8` - French
219+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
220+
* `-e LC_ALL=it_IT.UTF-8` - Italian
218221

219222
### Application Management
220223

@@ -226,7 +229,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
226229

227230
To install an application, use the command line inside the container:
228231

229-
```
232+
```bash
230233
proot-apps install filezilla
231234
```
232235

@@ -244,7 +247,7 @@ You can install packages from the system's native repository using the [universa
244247

245248
### Advanced Configuration
246249

247-
???+ note "Click to expand: Hardening Options"
250+
??? note "Click to expand: Hardening Options"
248251

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

@@ -266,21 +269,24 @@ You can install packages from the system's native repository using the [universa
266269
| **`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. |
267270

268271

269-
???+ note "Click to expand: Selkies Application Settings"
272+
??? note "Click to expand: Selkies Application Settings"
270273

271274
Using environment variables every facet of the application can be configured.
272275

273276
**Booleans and Locking:**
274277
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
275-
* Example: `-e SELKIES_USE_CPU="true|locked"`
278+
279+
* Example: `-e SELKIES_USE_CPU="true|locked"`
276280

277281
**Enums and Lists:**
278282
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.
279-
* Example: `-e SELKIES_ENCODER="jpeg"`
283+
284+
* Example: `-e SELKIES_ENCODER="jpeg"`
280285

281286
**Ranges:**
282287
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
283-
* Example: `-e SELKIES_FRAMERATE="60"`
288+
289+
* Example: `-e SELKIES_FRAMERATE="60"`
284290

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

0 commit comments

Comments
 (0)