Skip to content

Commit 927f440

Browse files
Bot Updating Templated Files
1 parent 15ea9e4 commit 927f440

1 file changed

Lines changed: 36 additions & 30 deletions

File tree

README.md

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

110110
To enable Wayland mode, set the following environment variable:
111-
* `-e PIXELFLUX_WAYLAND=true`
111+
112+
* `-e PIXELFLUX_WAYLAND=true`
112113

113114
**Why use Wayland?**
114-
* **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.
115-
* **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.
115+
116+
* **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.
117+
* **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.
116118

117119
#### GPU Configuration
118120

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

121123
**Configuration Variables:**
122-
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
123-
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
124+
125+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
126+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
124127

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

@@ -145,10 +148,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
145148
146149
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.
147150
148-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
149-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
150-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
151-
151+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
152+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
153+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
152154
153155
### Options in all Selkies-based GUI containers
154156
@@ -184,12 +186,13 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
184186
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
185187

186188
**`WATERMARK_LOCATION` Options:**
187-
- **1**: Top Left
188-
- **2**: Top Right
189-
- **3**: Bottom Left
190-
- **4**: Bottom Right
191-
- **5**: Centered
192-
- **6**: Animated
189+
190+
* **1**: Top Left
191+
* **2**: Top Right
192+
* **3**: Bottom Left
193+
* **4**: Bottom Right
194+
* **5**: Centered
195+
* **6**: Animated
193196

194197
</details>
195198

@@ -215,7 +218,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
215218

216219
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:
217220

218-
```
221+
```bash
219222
-e SELKIES_MANUAL_WIDTH=1920
220223
-e SELKIES_MANUAL_HEIGHT=1080
221224
-e MAX_RESOLUTION=1920x1080
@@ -227,16 +230,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
227230

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

230-
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
231-
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
232-
* `-e LC_ALL=ko_KR.UTF-8` - Korean
233-
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
234-
* `-e LC_ALL=ru_RU.UTF-8` - Russian
235-
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
236-
* `-e LC_ALL=de_DE.UTF-8` - German
237-
* `-e LC_ALL=fr_FR.UTF-8` - French
238-
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
239-
* `-e LC_ALL=it_IT.UTF-8` - Italian
233+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
234+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
235+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
236+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
237+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
238+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
239+
* `-e LC_ALL=de_DE.UTF-8` - German
240+
* `-e LC_ALL=fr_FR.UTF-8` - French
241+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
242+
* `-e LC_ALL=it_IT.UTF-8` - Italian
240243

241244
### Application Management
242245

@@ -248,7 +251,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
248251

249252
To install an application, use the command line inside the container:
250253

251-
```
254+
```bash
252255
proot-apps install filezilla
253256
```
254257

@@ -297,15 +300,18 @@ Using environment variables every facet of the application can be configured.
297300

298301
**Booleans and Locking:**
299302
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
300-
* Example: `-e SELKIES_USE_CPU="true|locked"`
303+
304+
* Example: `-e SELKIES_USE_CPU="true|locked"`
301305

302306
**Enums and Lists:**
303307
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.
304-
* Example: `-e SELKIES_ENCODER="jpeg"`
308+
309+
* Example: `-e SELKIES_ENCODER="jpeg"`
305310

306311
**Ranges:**
307312
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
308-
* Example: `-e SELKIES_FRAMERATE="60"`
313+
314+
* Example: `-e SELKIES_FRAMERATE="60"`
309315

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

0 commit comments

Comments
 (0)