Skip to content

Commit 31bc635

Browse files
Bot Updating Templated Files
1 parent 8beee73 commit 31bc635

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
@@ -89,19 +89,22 @@ We are currently transitioning our desktop containers from X11 to Wayland. While
8989
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
9090

9191
To enable Wayland mode, set the following environment variable:
92-
* `-e PIXELFLUX_WAYLAND=true`
92+
93+
* `-e PIXELFLUX_WAYLAND=true`
9394

9495
**Why use Wayland?**
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.
96+
97+
* **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.
98+
* **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.
9799

98100
#### GPU Configuration
99101

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

102104
**Configuration Variables:**
103-
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
104-
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
105+
106+
* `DRINODE`: The path to the GPU used for **Rendering** (EGL).
107+
* `DRI_NODE`: The path to the GPU used for **Encoding** (VAAPI/NVENC).
105108

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

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

167169
**`WATERMARK_LOCATION` Options:**
168-
- **1**: Top Left
169-
- **2**: Top Right
170-
- **3**: Bottom Left
171-
- **4**: Bottom Right
172-
- **5**: Centered
173-
- **6**: Animated
170+
171+
* **1**: Top Left
172+
* **2**: Top Right
173+
* **3**: Bottom Left
174+
* **4**: Bottom Right
175+
* **5**: Centered
176+
* **6**: Animated
174177

175178
</details>
176179

@@ -196,7 +199,7 @@ When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important t
196199

197200
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:
198201

199-
```
202+
```bash
200203
-e SELKIES_MANUAL_WIDTH=1920
201204
-e SELKIES_MANUAL_HEIGHT=1080
202205
-e MAX_RESOLUTION=1920x1080
@@ -208,16 +211,16 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
208211

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

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

222225
### Application Management
223226

@@ -229,7 +232,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
229232

230233
To install an application, use the command line inside the container:
231234

232-
```
235+
```bash
233236
proot-apps install filezilla
234237
```
235238

@@ -278,15 +281,18 @@ Using environment variables every facet of the application can be configured.
278281

279282
**Booleans and Locking:**
280283
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
281-
* Example: `-e SELKIES_USE_CPU="true|locked"`
284+
285+
* Example: `-e SELKIES_USE_CPU="true|locked"`
282286

283287
**Enums and Lists:**
284288
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.
285-
* Example: `-e SELKIES_ENCODER="jpeg"`
289+
290+
* Example: `-e SELKIES_ENCODER="jpeg"`
286291

287292
**Ranges:**
288293
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
289-
* Example: `-e SELKIES_FRAMERATE="60"`
294+
295+
* Example: `-e SELKIES_FRAMERATE="60"`
290296

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

0 commit comments

Comments
 (0)