Skip to content

Commit 80cece1

Browse files
Bot Updating Templated Files
1 parent cee1407 commit 80cece1

File tree

1 file changed

+36
-30
lines changed

1 file changed

+36
-30
lines changed

README.md

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

8989
To enable Wayland mode, set the following environment variable:
90-
* `-e PIXELFLUX_WAYLAND=true`
90+
91+
* `-e PIXELFLUX_WAYLAND=true`
9192

9293
**Why use Wayland?**
93-
* **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.
94-
* **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.
94+
95+
* **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.
96+
* **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.
9597

9698
#### GPU Configuration
9799

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

100102
**Configuration Variables:**
101-
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
102-
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
103+
104+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
105+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
103106

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

@@ -124,10 +127,9 @@ This container is compatible with [SealSkin](https://sealskin.app).
124127
125128
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.
126129
127-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
128-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
129-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
130-
130+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
131+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
132+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
131133
132134
### Options in all Selkies-based GUI containers
133135
@@ -163,12 +165,13 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
163165
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
164166

165167
**`WATERMARK_LOCATION` Options:**
166-
- **1**: Top Left
167-
- **2**: Top Right
168-
- **3**: Bottom Left
169-
- **4**: Bottom Right
170-
- **5**: Centered
171-
- **6**: Animated
168+
169+
* **1**: Top Left
170+
* **2**: Top Right
171+
* **3**: Bottom Left
172+
* **4**: Bottom Right
173+
* **5**: Centered
174+
* **6**: Animated
172175

173176
</details>
174177

@@ -194,7 +197,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
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
@@ -206,16 +209,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
206209

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

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

220223
### Application Management
221224

@@ -227,7 +230,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
227230

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

230-
```
233+
```bash
231234
proot-apps install filezilla
232235
```
233236

@@ -276,15 +279,18 @@ Using environment variables every facet of the application can be configured.
276279

277280
**Booleans and Locking:**
278281
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
279-
* Example: `-e SELKIES_USE_CPU="true|locked"`
282+
283+
* Example: `-e SELKIES_USE_CPU="true|locked"`
280284

281285
**Enums and Lists:**
282286
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.
283-
* Example: `-e SELKIES_ENCODER="jpeg"`
287+
288+
* Example: `-e SELKIES_ENCODER="jpeg"`
284289

285290
**Ranges:**
286291
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
287-
* Example: `-e SELKIES_FRAMERATE="60"`
292+
293+
* Example: `-e SELKIES_FRAMERATE="60"`
288294

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

0 commit comments

Comments
 (0)