Skip to content

Commit 29928c3

Browse files
Bot Updating Documentation
1 parent 921e5e7 commit 29928c3

File tree

1 file changed

+41
-35
lines changed

1 file changed

+41
-35
lines changed

docs/images/docker-wireshark.md

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

7474
To enable Wayland mode, set the following environment variable:
75-
* `-e PIXELFLUX_WAYLAND=true`
75+
76+
* `-e PIXELFLUX_WAYLAND=true`
7677

7778
**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.
8082

8183
#### GPU Configuration
8284

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

8587
**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).
8891

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

@@ -109,16 +112,15 @@ This container is compatible with [SealSkin](https://sealskin.app).
109112
110113
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.
111114
112-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
113-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
114-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
115-
115+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
116+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
117+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
116118
117119
### Options in all Selkies-based GUI containers
118120
119121
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies).
120122
121-
???+ note "Click to expand: Optional Environment Variables"
123+
??? note "Click to expand: Optional Environment Variables"
122124
123125
| Variable | Description |
124126
| :----: | --- |
@@ -147,15 +149,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
147149
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
148150

149151
**`WATERMARK_LOCATION` Options:**
150-
- **1**: Top Left
151-
- **2**: Top Right
152-
- **3**: Bottom Left
153-
- **4**: Bottom Right
154-
- **5**: Centered
155-
- **6**: Animated
152+
153+
* **1**: Top Left
154+
* **2**: Top Right
155+
* **3**: Bottom Left
156+
* **4**: Bottom Right
157+
* **5**: Centered
158+
* **6**: Animated
156159

157160

158-
???+ note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
161+
??? note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
159162

160163
| Argument | Description |
161164
| :----: | --- |
@@ -164,7 +167,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
164167
| `--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. |
165168

166169

167-
???+ note "Click to expand: Legacy X11 Resolution & Acceleration"
170+
??? note "Click to expand: Legacy X11 Resolution & Acceleration"
168171

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

@@ -174,7 +177,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
174177

175178
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:
176179

177-
```
180+
```bash
178181
-e SELKIES_MANUAL_WIDTH=1920
179182
-e SELKIES_MANUAL_HEIGHT=1080
180183
-e MAX_RESOLUTION=1920x1080
@@ -185,16 +188,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
185188

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

188-
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
189-
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
190-
* `-e LC_ALL=ko_KR.UTF-8` - Korean
191-
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
192-
* `-e LC_ALL=ru_RU.UTF-8` - Russian
193-
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
194-
* `-e LC_ALL=de_DE.UTF-8` - German
195-
* `-e LC_ALL=fr_FR.UTF-8` - French
196-
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
197-
* `-e LC_ALL=it_IT.UTF-8` - Italian
191+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
192+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
193+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
194+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
195+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
196+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
197+
* `-e LC_ALL=de_DE.UTF-8` - German
198+
* `-e LC_ALL=fr_FR.UTF-8` - French
199+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
200+
* `-e LC_ALL=it_IT.UTF-8` - Italian
198201

199202
### Application Management
200203

@@ -206,7 +209,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
206209

207210
To install an application, use the command line inside the container:
208211

209-
```
212+
```bash
210213
proot-apps install filezilla
211214
```
212215

@@ -224,7 +227,7 @@ You can install packages from the system's native repository using the [universa
224227

225228
### Advanced Configuration
226229

227-
???+ note "Click to expand: Hardening Options"
230+
??? note "Click to expand: Hardening Options"
228231

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

@@ -246,21 +249,24 @@ You can install packages from the system's native repository using the [universa
246249
| **`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. |
247250

248251

249-
???+ note "Click to expand: Selkies Application Settings"
252+
??? note "Click to expand: Selkies Application Settings"
250253

251254
Using environment variables every facet of the application can be configured.
252255

253256
**Booleans and Locking:**
254257
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
255-
* Example: `-e SELKIES_USE_CPU="true|locked"`
258+
259+
* Example: `-e SELKIES_USE_CPU="true|locked"`
256260

257261
**Enums and Lists:**
258262
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.
259-
* Example: `-e SELKIES_ENCODER="jpeg"`
263+
264+
* Example: `-e SELKIES_ENCODER="jpeg"`
260265

261266
**Ranges:**
262267
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
263-
* Example: `-e SELKIES_FRAMERATE="60"`
268+
269+
* Example: `-e SELKIES_FRAMERATE="60"`
264270

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

0 commit comments

Comments
 (0)