Skip to content

Commit b1cf11f

Browse files
Bot Updating Documentation
1 parent 96f5263 commit b1cf11f

File tree

1 file changed

+41
-35
lines changed

1 file changed

+41
-35
lines changed

docs/images/docker-krita.md

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

7373
To enable Wayland mode, set the following environment variable:
74-
* `-e PIXELFLUX_WAYLAND=true`
74+
75+
* `-e PIXELFLUX_WAYLAND=true`
7576

7677
**Why use Wayland?**
77-
* **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.
78-
* **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.
78+
79+
* **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.
80+
* **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.
7981

8082
#### GPU Configuration
8183

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

8486
**Configuration Variables:**
85-
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
86-
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
87+
88+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
89+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
8790

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

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

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

156159

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

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

165168

166-
???+ note "Click to expand: Legacy X11 Resolution & Acceleration"
169+
??? note "Click to expand: Legacy X11 Resolution & Acceleration"
167170

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

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

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

176-
```
179+
```bash
177180
-e SELKIES_MANUAL_WIDTH=1920
178181
-e SELKIES_MANUAL_HEIGHT=1080
179182
-e MAX_RESOLUTION=1920x1080
@@ -184,16 +187,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
184187

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

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
190+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
191+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
192+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
193+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
194+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
195+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
196+
* `-e LC_ALL=de_DE.UTF-8` - German
197+
* `-e LC_ALL=fr_FR.UTF-8` - French
198+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
199+
* `-e LC_ALL=it_IT.UTF-8` - Italian
197200

198201
### Application Management
199202

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

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

208-
```
211+
```bash
209212
proot-apps install filezilla
210213
```
211214

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

224227
### Advanced Configuration
225228

226-
???+ note "Click to expand: Hardening Options"
229+
??? note "Click to expand: Hardening Options"
227230

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

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

247250

248-
???+ note "Click to expand: Selkies Application Settings"
251+
??? note "Click to expand: Selkies Application Settings"
249252

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

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

256260
**Enums and Lists:**
257261
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.
258-
* Example: `-e SELKIES_ENCODER="jpeg"`
262+
263+
* Example: `-e SELKIES_ENCODER="jpeg"`
259264

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

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

0 commit comments

Comments
 (0)