Skip to content

Commit e4136e1

Browse files
Bot Updating Documentation
1 parent a98c75b commit e4136e1

File tree

1 file changed

+48
-39
lines changed

1 file changed

+48
-39
lines changed

docs/images/docker-kali-linux.md

Lines changed: 48 additions & 39 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

@@ -106,10 +109,12 @@ For Intel and AMD GPUs.
106109
**Note: Nvidia support is not available for Alpine-based images.**
107110
108111
**Prerequisites:**
109-
1. **Driver:** Proprietary drivers **580 or higher** are required.
110-
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
111-
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
112-
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
112+
113+
1. **Driver:** Proprietary drivers **580 or higher** are required.
114+
2. **Kernel Parameter:** Set `nvidia-drm.modeset=1` in your host bootloader (GRUB/systemd-boot).
115+
3. **Initialization:** On headless systems, run `nvidia-modprobe --modeset` on the host (once per boot) to initialize the card.
116+
4. **Docker Runtime:** Configure the host docker daemon to use the Nvidia runtime:
117+
113118
```bash
114119
sudo nvidia-ctk runtime configure --runtime=docker
115120
sudo systemctl restart docker
@@ -118,6 +123,7 @@ For Intel and AMD GPUs.
118123
**Compose Configuration:**
119124

120125
```yaml
126+
---
121127
services:
122128
kali-linux:
123129
image: lscr.io/linuxserver/kali-linux:latest
@@ -141,16 +147,15 @@ This container is compatible with [SealSkin](https://sealskin.app).
141147

142148
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.
143149

144-
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
145-
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
146-
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
147-
150+
* **SealSkin Server:** [Get it Here](https://github.com/linuxserver/docker-sealskin)
151+
* **Browser Extension:** [Chrome](https://chromewebstore.google.com/detail/sealskin-isolation/lclgfmnljgacfdpmmmjmfpdelndbbfhk) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/sealskin-isolation/).
152+
* **Mobile App:** [iOS](https://apps.apple.com/us/app/sealskin/id6758210210) and [Android](https://play.google.com/store/apps/details?id=io.linuxserver.sealskin)
148153

149154
### Options in all Selkies-based GUI containers
150155

151156
This container is based on [Docker Baseimage Selkies](https://github.com/linuxserver/docker-baseimage-selkies).
152157

153-
???+ note "Click to expand: Optional Environment Variables"
158+
??? note "Click to expand: Optional Environment Variables"
154159

155160
| Variable | Description |
156161
| :----: | --- |
@@ -179,15 +184,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
179184
| WATERMARK_LOCATION | Where to paint the image over the stream integer options below |
180185

181186
**`WATERMARK_LOCATION` Options:**
182-
- **1**: Top Left
183-
- **2**: Top Right
184-
- **3**: Bottom Left
185-
- **4**: Bottom Right
186-
- **5**: Centered
187-
- **6**: Animated
187+
188+
* **1**: Top Left
189+
* **2**: Top Right
190+
* **3**: Bottom Left
191+
* **4**: Bottom Right
192+
* **5**: Centered
193+
* **6**: Animated
188194

189195

190-
???+ note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
196+
??? note "Click to expand: Optional Run Configurations (DinD & GPU Mounts)"
191197

192198
| Argument | Description |
193199
| :----: | --- |
@@ -196,7 +202,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
196202
| `--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. |
197203

198204

199-
???+ note "Click to expand: Legacy X11 Resolution & Acceleration"
205+
??? note "Click to expand: Legacy X11 Resolution & Acceleration"
200206

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

@@ -206,7 +212,7 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
206212

207213
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:
208214

209-
```
215+
```bash
210216
-e SELKIES_MANUAL_WIDTH=1920
211217
-e SELKIES_MANUAL_HEIGHT=1080
212218
-e MAX_RESOLUTION=1920x1080
@@ -217,16 +223,16 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
217223

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

220-
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
221-
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
222-
* `-e LC_ALL=ko_KR.UTF-8` - Korean
223-
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
224-
* `-e LC_ALL=ru_RU.UTF-8` - Russian
225-
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
226-
* `-e LC_ALL=de_DE.UTF-8` - German
227-
* `-e LC_ALL=fr_FR.UTF-8` - French
228-
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
229-
* `-e LC_ALL=it_IT.UTF-8` - Italian
226+
* `-e LC_ALL=zh_CN.UTF-8` - Chinese
227+
* `-e LC_ALL=ja_JP.UTF-8` - Japanese
228+
* `-e LC_ALL=ko_KR.UTF-8` - Korean
229+
* `-e LC_ALL=ar_AE.UTF-8` - Arabic
230+
* `-e LC_ALL=ru_RU.UTF-8` - Russian
231+
* `-e LC_ALL=es_MX.UTF-8` - Spanish (Latin America)
232+
* `-e LC_ALL=de_DE.UTF-8` - German
233+
* `-e LC_ALL=fr_FR.UTF-8` - French
234+
* `-e LC_ALL=nl_NL.UTF-8` - Netherlands
235+
* `-e LC_ALL=it_IT.UTF-8` - Italian
230236

231237
### Application Management
232238

@@ -238,7 +244,7 @@ Natively installed packages (e.g., via `apt-get install`) will not persist if th
238244

239245
To install an application, use the command line inside the container:
240246

241-
```
247+
```bash
242248
proot-apps install filezilla
243249
```
244250

@@ -256,7 +262,7 @@ You can install packages from the system's native repository using the [universa
256262

257263
### Advanced Configuration
258264

259-
???+ note "Click to expand: Hardening Options"
265+
??? note "Click to expand: Hardening Options"
260266

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

@@ -278,21 +284,24 @@ You can install packages from the system's native repository using the [universa
278284
| **`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. |
279285

280286

281-
???+ note "Click to expand: Selkies Application Settings"
287+
??? note "Click to expand: Selkies Application Settings"
282288

283289
Using environment variables every facet of the application can be configured.
284290

285291
**Booleans and Locking:**
286292
Boolean settings accept `true` or `false`. You can also prevent the user from changing a boolean setting in the UI by appending `|locked`.
287-
* Example: `-e SELKIES_USE_CPU="true|locked"`
293+
294+
* Example: `-e SELKIES_USE_CPU="true|locked"`
288295

289296
**Enums and Lists:**
290297
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.
291-
* Example: `-e SELKIES_ENCODER="jpeg"`
298+
299+
* Example: `-e SELKIES_ENCODER="jpeg"`
292300

293301
**Ranges:**
294302
Use a hyphen-separated `min-max` format for a slider, or a single number to lock the value.
295-
* Example: `-e SELKIES_FRAMERATE="60"`
303+
304+
* Example: `-e SELKIES_FRAMERATE="60"`
296305

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

0 commit comments

Comments
 (0)