Skip to content

Commit 3a2b9d6

Browse files
committed
Use collapsible blocks
1 parent c792001 commit 3a2b9d6

1 file changed

Lines changed: 15 additions & 24 deletions

File tree

  • ansible/roles/documentation/templates/README_SNIPPETS

ansible/roles/documentation/templates/README_SNIPPETS/SELKIES.j2

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,7 @@ SealSkin is a self-hosted, client-server platform that provides secure authentic
9999

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

102-
<details>
103-
<summary>Click to expand: Optional Environment Variables</summary>
104-
102+
{% set blurb1 %}
105103
| Variable | Description |
106104
| :----: | --- |
107105
| PIXELFLUX_WAYLAND | **Experimental** If set to true the container will initialize in Wayland mode running [Smithay](https://github.com/Smithay/smithay) and Labwc while enabling zero copy encoding with a GPU |
@@ -135,23 +133,19 @@ This container is based on [Docker Baseimage Selkies](https://github.com/linuxse
135133
- **4**: Bottom Right
136134
- **5**: Centered
137135
- **6**: Animated
136+
{% endset %}
137+
{{ blurb1 | admonition(flavour=markdown, title="Click to expand: Optional Environment Variables", collapse="???") }}
138138

139-
</details>
140-
141-
<details>
142-
<summary>Click to expand: Optional Run Configurations (DinD & GPU Mounts)</summary>
143-
139+
{% set blurb2 %}
144140
| Argument | Description |
145141
| :----: | --- |
146142
| `--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`. |
147143
| `-v /var/run/docker.sock:/var/run/docker.sock` | Mounts the host's Docker socket to manage host containers from within this container. |
148144
| `--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. |
145+
{% endset %}
146+
{{ blurb2 | admonition(flavour=markdown, title="Click to expand: Optional Run Configurations (DinD & GPU Mounts)", collapse="???") }}
149147

150-
</details>
151-
152-
<details>
153-
<summary>Click to expand: Legacy X11 Resolution & Acceleration</summary>
154-
148+
{% set blurb3 %}
155149
**Note:** This section applies only if you are **NOT** using `PIXELFLUX_WAYLAND=true`.
156150

157151
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.
@@ -165,7 +159,8 @@ This will set the total virtual framebuffer to 4K. By default, the virtual monit
165159
-e SELKIES_MANUAL_HEIGHT=1080
166160
-e MAX_RESOLUTION=1920x1080
167161
```
168-
</details>
162+
{% endset %}
163+
{{ blurb3 | admonition(flavour=markdown, title="Click to expand: Legacy X11 Resolution & Acceleration", collapse="???") }}
169164

170165
### Language Support - Internationalization
171166

@@ -210,9 +205,7 @@ You can install packages from the system's native repository using the [universa
210205

211206
### Advanced Configuration
212207

213-
<details>
214-
<summary>Click to expand: Hardening Options</summary>
215-
208+
{% set blurb4 %}
216209
These variables can be used to lock down the desktop environment for single-application use cases or to restrict user capabilities.
217210

218211
| Variable | Description |
@@ -231,12 +224,10 @@ These variables can be used to lock down the desktop environment for single-appl
231224
| **`DISABLE_MOUSE_BUTTONS`** | If true, disables the right-click and middle-click context menus and actions within the Openbox window manager. |
232225
| **`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). |
233226
| **`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. |
227+
{% endset %}
228+
{{ blurb4 | admonition(flavour=markdown, title="Click to expand: Hardening Options", collapse="???") }}
234229

235-
</details>
236-
237-
<details>
238-
<summary>Click to expand: Selkies Application Settings</summary>
239-
230+
{% set blurb5 %}
240231
Using environment variables every facet of the application can be configured.
241232

242233
**Booleans and Locking:**
@@ -312,5 +303,5 @@ If `SELKIES_MANUAL_WIDTH` or `SELKIES_MANUAL_HEIGHT` are set, the resolution is
312303
| `SELKIES_ENABLE_PLAYER2` | `True` | Enable sharing link for gamepad player 2. |
313304
| `SELKIES_ENABLE_PLAYER3` | `True` | Enable sharing link for gamepad player 3. |
314305
| `SELKIES_ENABLE_PLAYER4` | `True` | Enable sharing link for gamepad player 4. |
315-
316-
</details>
306+
{% endset %}
307+
{{ blurb5 | admonition(flavour=markdown, title="Click to expand: Selkies Application Settings", collapse="???") }}

0 commit comments

Comments
 (0)