Skip to content

Commit fe9a9c0

Browse files
Bot Updating Documentation
1 parent b489f40 commit fe9a9c0

1 file changed

Lines changed: 41 additions & 35 deletions

File tree

docs/images/docker-yaak.md

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

7070
To enable Wayland mode, set the following environment variable:
71-
* `-e PIXELFLUX_WAYLAND=true`
71+
72+
* `-e PIXELFLUX_WAYLAND=true`
7273

7374
**Why use Wayland?**
74-
* **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.
75-
* **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.
75+
76+
* **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.
77+
* **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.
7678

7779
#### GPU Configuration
7880

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

8183
**Configuration Variables:**
82-
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
83-
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
84+
85+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
86+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
8487

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

@@ -105,16 +108,15 @@ This container is compatible with [SealSkin](https://sealskin.app).
105108
106109
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.
107110
108-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
109-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
110-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
111-
111+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
112+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
113+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
112114
113115
### Options in all Selkies-based GUI containers
114116
115117
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies).
116118
117-
???+ note "Click to expand: Optional Environment Variables"
119+
??? note "Click to expand: Optional Environment Variables"
118120
119121
| Variable | Description |
120122
| :----: | --- |
@@ -143,15 +145,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
143145
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
144146

145147
**`WATERMARK_LOCATION` Options:**
146-
- **1**: Top Left
147-
- **2**: Top Right
148-
- **3**: Bottom Left
149-
- **4**: Bottom Right
150-
- **5**: Centered
151-
- **6**: Animated
148+
149+
* **1**: Top Left
150+
* **2**: Top Right
151+
* **3**: Bottom Left
152+
* **4**: Bottom Right
153+
* **5**: Centered
154+
* **6**: Animated
152155

153156

154-
???+ note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
157+
??? note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
155158

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

162165

163-
???+ note "Click to expand: Legacy X11 Resolution & Acceleration"
166+
??? note "Click to expand: Legacy X11 Resolution & Acceleration"
164167

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

@@ -170,7 +173,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
170173

171174
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:
172175

173-
```
176+
```bash
174177
-e SELKIES_MANUAL_WIDTH=1920
175178
-e SELKIES_MANUAL_HEIGHT=1080
176179
-e MAX_RESOLUTION=1920x1080
@@ -181,16 +184,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
181184

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

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

195198
### Application Management
196199

@@ -202,7 +205,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
202205

203206
To install an application, use the command line inside the container:
204207

205-
```
208+
```bash
206209
proot-apps install filezilla
207210
```
208211

@@ -220,7 +223,7 @@ You can install packages from the system's native repository using the [universa
220223

221224
### Advanced Configuration
222225

223-
???+ note "Click to expand: Hardening Options"
226+
??? note "Click to expand: Hardening Options"
224227

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

@@ -242,21 +245,24 @@ You can install packages from the system's native repository using the [universa
242245
| **`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. |
243246

244247

245-
???+ note "Click to expand: Selkies Application Settings"
248+
??? note "Click to expand: Selkies Application Settings"
246249

247250
Using environment variables every facet of the application can be configured.
248251

249252
**Booleans and Locking:**
250253
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
251-
* Example: `-e SELKIES_USE_CPU="true|locked"`
254+
255+
* Example: `-e SELKIES_USE_CPU="true|locked"`
252256

253257
**Enums and Lists:**
254258
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.
255-
* Example: `-e SELKIES_ENCODER="jpeg"`
259+
260+
* Example: `-e SELKIES_ENCODER="jpeg"`
256261

257262
**Ranges:**
258263
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
259-
* Example: `-e SELKIES_FRAMERATE="60"`
264+
265+
* Example: `-e SELKIES_FRAMERATE="60"`
260266

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

0 commit comments

Comments
 (0)