Skip to content

Commit 98f217b

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent eb18b52 commit 98f217b

1 file changed

Lines changed: 101 additions & 87 deletions

File tree

‎README.md‎

Lines changed: 101 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,61 @@ The web interface includes a terminal with passwordless `sudo` access. Any user
101101

102102
While not generally recommended, certain legacy environments specifically those with older hardware or outdated Linux distributions may require the deactivation of the standard seccomp profile to get containerized desktop software to run. This can be achieved by utilizing the `--security-opt seccomp=unconfined` parameter. It is critical to use this option only when absolutely necessary as it disables a key security layer of Docker, elevating the potential for container escape vulnerabilities.
103103

104+
### Hardware Acceleration & The Move to Wayland
105+
106+
We are currently transitioning our desktop containers from X11 to Wayland. While X11 is still the default, we strongly encourage users to test the new Wayland mode.
107+
108+
**Important:** GPU acceleration support for X11 is being deprecated. Future development for hardware acceleration will focus entirely on the Wayland stack.
109+
110+
To enable Wayland mode, set the following environment variable:
111+
* `-e PIXELFLUX_WAYLAND=true`
112+
113+
**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.
116+
117+
#### GPU Configuration
118+
119+
To use hardware acceleration in Wayland mode, we distinguish between the card used for **Rendering** (3D apps/Desktops) and **Encoding** (Video Stream).
120+
121+
**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+
If both variables point to the same device, the container will automatically enable **Zero Copy** encoding, significantly reducing CPU usage and latency.
126+
127+
##### Intel & AMD (Open Source Drivers)
128+
129+
For Intel and AMD GPUs.
130+
131+
```yaml
132+
devices:
133+
- /dev/dri:/dev/dri
134+
environment:
135+
- PIXELFLUX_WAYLAND=true
136+
# Optional: Specify device if multiple exist (IE: /dev/dri/renderD129)
137+
- DRINODE=/dev/dri/renderD128
138+
- DRI_NODE=/dev/dri/renderD128
139+
```
140+
141+
142+
### SealSkin Compatibility
143+
144+
This container is compatible with [SealSkin](https://sealskin.app).
145+
146+
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.
147+
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+
152+
104153
### Options in all Selkies-based GUI containers
105154
106-
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies), which provides the following environment variables and run configurations to customize its functionality.
155+
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies).
107156
108-
#### Optional Environment Variables
157+
<details>
158+
<summary>Click to expand: Optional Environment Variables</summary>
109159
110160
| Variable | Description |
111161
| :----: | --- |
@@ -114,8 +164,8 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
114164
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default `3001` |
115165
| CUSTOM_WS_PORT | Internal port the container listens on for websockets if it needs to be swapped from the default 8082 |
116166
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
117-
| DRI_NODE | Enable VAAPI stream encoding and use the specified device IE `/dev/dri/renderD128` |
118-
| DRINODE | Specify which GPU to use for DRI3 acceleration IE `/dev/dri/renderD129` |
167+
| DRI_NODE | **Encoding GPU**: Enable VAAPI/NVENC stream encoding and use the specified device IE `/dev/dri/renderD128` |
168+
| DRINODE | **Rendering GPU**: Specify which GPU to use for EGL/3D acceleration IE `/dev/dri/renderD129` |
119169
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
120170
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE `/subfolder/` |
121171
| TITLE | The page title displayed on the web browser, default "Selkies" |
@@ -141,70 +191,52 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
141191
- **5**: Centered
142192
- **6**: Animated
143193

144-
#### Optional Run Configurations
194+
</details>
195+
196+
<details>
197+
<summary>Click to expand: Optional Run Configurations (DinD & GPU Mounts)</summary>
145198

146199
| Argument | Description |
147200
| :----: | --- |
148201
| `--privileged` | Starts a Docker-in-Docker (DinD) environment. For better performance, mount the Docker data directory from the host, e.g., `-v /path/to/docker-data:/var/lib/docker`. |
149202
| `-v /var/run/docker.sock:/var/run/docker.sock` | Mounts the host's Docker socket to manage host containers from within this container. |
150-
| `--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. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
151-
152-
### Language Support - Internationalization
153-
154-
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
155-
156-
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
157-
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
158-
* `-e LC_ALL=ko_KR.UTF-8` - Korean
159-
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
160-
* `-e LC_ALL=ru_RU.UTF-8` - Russian
161-
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
162-
* `-e LC_ALL=de_DE.UTF-8` - German
163-
* `-e LC_ALL=fr_FR.UTF-8` - French
164-
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
165-
* `-e LC_ALL=it_IT.UTF-8` - Italian
166-
167-
### SealSkin Compatibility
203+
| `--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. |
168204

169-
This container is compatible with [SealSkin](https://github.com/linuxserver/docker-sealskin).
170-
171-
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.
205+
</details>
172206

173-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
174-
* **Browser Extension:** [Install Here](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk)
207+
<details>
208+
<summary>Click to expand: Legacy X11 Resolution & Acceleration</summary>
175209

176-
### All GPU Acceleration - use sane resolutions
210+
**Note:** This section applies only if you are **NOT** using `PIXELFLUX_WAYLAND=true`.
177211

178-
When using 3d acceleration via Nvidia DRM or DRI3 it is important to clamp the virtual display to a reasonable max resolution. This can be achieved with the environment setting:
212+
When using 3d acceleration via Nvidia DRM or DRI3 in X11 mode, it is important to clamp the virtual display to a reasonable max resolution to avoid memory exhaustion or poor performance.
179213

180214
* `-e MAX_RESOLUTION=3840x2160`
181215

182-
This will set the total virtual framebuffer to 4K, you can also set a manual resolution to achieve this.
183-
By default the virtual monitor in the session is 16K to support large monitors and dual display configurations. Leaving it this large has no impact on CPU based performance but costs GPU memory usage and memory bandwidth when leveraging one for acceleration. If you have performance issues in an accelerated session, try clamping the resolution to 1080p and work up from there:
216+
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:
184217

185218
```
186219
-e SELKIES_MANUAL_WIDTH=1920
187220
-e SELKIES_MANUAL_HEIGHT=1080
188221
-e MAX_RESOLUTION=1920x1080
189222
```
190223

191-
### DRI3 GPU Acceleration
192-
193-
For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:
194-
195-
`--device /dev/dri:/dev/dri`
224+
</details>
196225

197-
This feature only supports **Open Source** GPU drivers:
198-
199-
| Driver | Description |
200-
| :----: | --- |
201-
| Intel | i965 and i915 drivers for Intel iGPU chipsets |
202-
| AMD | AMDGPU, Radeon, and ATI drivers for AMD dedicated or APU chipsets |
203-
| NVIDIA | nouveau2 drivers only, closed source NVIDIA drivers lack DRI3 support |
226+
### Language Support - Internationalization
204227

205-
The `DRINODE` environment variable can be used to point to a specific GPU.
228+
To launch the desktop session in a different language, set the `LC_ALL` environment variable. For example:
206229

207-
DRI3 will work on aarch64 given the correct drivers are installed inside the container for your chipset.
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
208240

209241
### Application Management
210242

@@ -232,20 +264,19 @@ You can install packages from the system's native repository using the [universa
232264
- INSTALL_PACKAGES=libfuse2|git|gdb
233265
```
234266

235-
#### Hardening
267+
### Advanced Configuration
236268

237-
These variables can be used to lock down the desktop environment for single-application use cases or to restrict user capabilities.
269+
<details>
270+
<summary>Click to expand: Hardening Options</summary>
238271

239-
##### Meta Variables
240-
241-
These variables act as presets, enabling multiple hardening options at once. Individual options can still be set to override the preset.
272+
These variables can be used to lock down the desktop environment for single-application use cases or to restrict user capabilities.
242273

243274
| Variable | Description |
244275
| :----: | --- |
245276
| **`HARDEN_DESKTOP`** | Enables `DISABLE_OPEN_TOOLS`, `DISABLE_SUDO`, and `DISABLE_TERMINALS`. Also sets related Selkies UI settings (`SELKIES_FILE_TRANSFERS`, `SELKIES_COMMAND_ENABLED`, `SELKIES_UI_SIDEBAR_SHOW_FILES`, `SELKIES_UI_SIDEBAR_SHOW_APPS`) if they are not explicitly set by the user. |
246277
| **`HARDEN_OPENBOX`** | Enables `DISABLE_CLOSE_BUTTON`, `DISABLE_MOUSE_BUTTONS`, and `HARDEN_KEYBINDS`. It also flags `RESTART_APP` if not set by the user, ensuring the primary application is automatically restarted if closed. |
247278

248-
##### Individual Hardening Variables
279+
**Individual Hardening Variables:**
249280

250281
| Variable | Description |
251282
| :--- | --- |
@@ -257,46 +288,27 @@ These variables act as presets, enabling multiple hardening options at once. Ind
257288
| **`HARDEN_KEYBINDS`** | If true, disables default Openbox keybinds that can bypass other hardening options (e.g., `Alt+F4` to close windows, `Alt+Escape` to show the root menu). |
258289
| **`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. |
259290

260-
#### Selkies application settings
291+
</details>
261292

262-
Using environment variables every facet of the application can be configured.
263-
264-
##### Booleans and Locking
265-
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`. The UI toggle for this setting will be hidden.
266-
267-
* **Example**: To force CPU encoding on and prevent the user from disabling it:
268-
```bash
269-
-e SELKIES_USE_CPU="true|locked"
270-
```
293+
<details>
294+
<summary>Click to expand: Selkies Application Settings</summary>
271295

272-
##### Enums and Lists
273-
These settings accept a comma-separated list of values. Their behavior depends on the number of items provided:
274-
275-
* **Multiple Values**: The first item in the list becomes the default selection, and all items in the list become the available options in the UI dropdown.
276-
* **Single Value**: The provided value becomes the default, and the UI dropdown is hidden because the choice is locked.
277-
278-
* **Example**: Force the encoder to be `jpeg` with no other options available to the user:
279-
```bash
280-
-e SELKIES_ENCODER="jpeg"
281-
```
282-
283-
##### Ranges
284-
Range settings define a minimum and maximum for a value (e.g., framerate).
296+
Using environment variables every facet of the application can be configured.
285297

286-
* **To set a range**: Use a hyphen-separated `min-max` format. The UI will show a slider.
287-
* **To set a fixed value**: Provide a single number. This will lock the value and hide the UI slider.
298+
**Booleans and Locking:**
299+
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"`
288301

289-
* **Example**: Lock the framerate to exactly 60 FPS.
290-
```bash
291-
-e SELKIES_FRAMERATE="60"
292-
```
302+
**Enums and Lists:**
303+
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"`
293305

294-
##### Manual Resolution Mode
295-
The server can be forced to use a single, fixed resolution for all connecting clients. This mode is automatically activated if `SELKIES_MANUAL_WIDTH`, `SELKIES_MANUAL_HEIGHT`, or `SELKIES_IS_MANUAL_RESOLUTION_MODE` is set.
306+
**Ranges:**
307+
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
308+
* Example: `-e SELKIES_FRAMERATE="60"`
296309

297-
* If `SELKIES_MANUAL_WIDTH` and/or `SELKIES_MANUAL_HEIGHT` are set, the resolution is locked to those values.
298-
* If `SELKIES_IS_MANUAL_RESOLUTION_MODE` is set to `true` without specifying width or height, the resolution defaults to **1024x768**.
299-
* When this mode is active, the client UI for changing resolution is disabled.
310+
**Manual Resolution Mode:**
311+
If `SELKIES_MANUAL_WIDTH` or `SELKIES_MANUAL_HEIGHT` are set, the resolution is locked to those values.
300312

301313
| Environment Variable | Default Value | Description |
302314
| --- | --- | --- |
@@ -357,12 +369,14 @@ The server can be forced to use a single, fixed resolution for all connecting cl
357369
| `SELKIES_ENABLE_PLAYER3` | `True` | Enable sharing link for gamepad player 3. |
358370
| `SELKIES_ENABLE_PLAYER4` | `True` | Enable sharing link for gamepad player 4. |
359371

372+
</details>
373+
360374
## Usage
361375

362376
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
363377

364378
>[!NOTE]
365-
>Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.
379+
>Unless a parameter is flagged as 'optional', it is *mandatory* and a value must be provided.
366380

367381
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
368382

0 commit comments

Comments
 (0)