Skip to content

Commit 9612ee1

Browse files
author
docs-bot
committed
docs: update from source@746a9e1
1 parent bd359a7 commit 9612ee1

18 files changed

Lines changed: 231 additions & 9 deletions

‎docs/anland.html‎

Lines changed: 196 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/community-supported-devices.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<a href="features.html" class="sidebar-link">Container settings</a>
6161
<a href="linux-cli.html" class="sidebar-link">Linux CLI</a>
6262
<a href="graphics-and-audio.html" class="sidebar-link">Display, audio and desktop</a>
63+
<a href="anland.html" class="sidebar-link">Anland</a>
6364
<a href="kernel-configuration.html" class="sidebar-link">Kernel configuration</a>
6465
<a href="networking-from-zero.html" class="sidebar-link">Networking from zero</a>
6566
</details>

‎docs/cool-things-you-can-do.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<a href="features.html" class="sidebar-link">Container settings</a>
6161
<a href="linux-cli.html" class="sidebar-link">Linux CLI</a>
6262
<a href="graphics-and-audio.html" class="sidebar-link">Display, audio and desktop</a>
63+
<a href="anland.html" class="sidebar-link">Anland</a>
6364
<a href="kernel-configuration.html" class="sidebar-link">Kernel configuration</a>
6465
<a href="networking-from-zero.html" class="sidebar-link">Networking from zero</a>
6566
</details>

‎docs/features.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<a href="features.html" class="sidebar-link" aria-current="page">Container settings</a>
6161
<a href="linux-cli.html" class="sidebar-link">Linux CLI</a>
6262
<a href="graphics-and-audio.html" class="sidebar-link">Display, audio and desktop</a>
63+
<a href="anland.html" class="sidebar-link">Anland</a>
6364
<a href="kernel-configuration.html" class="sidebar-link">Kernel configuration</a>
6465
<a href="networking-from-zero.html" class="sidebar-link">Networking from zero</a>
6566
</details>
@@ -147,6 +148,8 @@ <h3 id="gpu-access">GPU Access <a class="header-anchor" href="#gpu-access">#</a>
147148
<p>Known GPU families: Mesa DRI render nodes on Intel, AMD and most ARM SoCs, Qualcomm Adreno (<code>kgsl</code>), ARM Mali, NVIDIA, PowerVR and the DMA heaps these drivers need.</p>
148149
<h3 id="configure-termuxx11">Configure Termux:X11 <a class="header-anchor" href="#configure-termuxx11">#</a></h3>
149150
<p><code>--x11</code>, key <code>enable_x11</code>. Android: starts the Termux:X11 server when the container starts, mounts its socket into the container, and sets <code>DISPLAY</code> for every login shell. Needs the Termux and Termux:X11 apps and the one-time setup in the <a href="graphics-and-audio.html">display guide</a>. Linux: mounts the host's X11 socket so GUI programs in the container open on your desktop.</p>
151+
<h3 id="anland-display">Anland Display <a class="header-anchor" href="#anland-display">#</a></h3>
152+
<p><code>--anland</code>, key <code>enable_anland</code>. Android only. Starts the Anland display daemon for the container, so a Wayland compositor patched for Anland can show its desktop in the Anland app. Needs GPU Access, a patched compositor in the container and the Anland app on the phone, and it replaces Termux:X11 rather than adding to it. The <a href="anland.html">Anland guide</a> walks through it.</p>
150153
<h3 id="configure-virgl-3d-acceleration">Configure VirGL 3D Acceleration <a class="header-anchor" href="#configure-virgl-3d-acceleration">#</a></h3>
151154
<p><code>--virgl</code>, key <code>enable_virgl</code>. Android only. Starts the VirGL server in Termux alongside Termux:X11 and sets <code>GALLIUM_DRIVER=virpipe</code> in the container, so OpenGL programs render on the phone's GPU instead of in software. The right choice on Mali and PowerVR GPUs. On Qualcomm, Turnip inside the container with GPU Access is faster; the <a href="graphics-and-audio.html">display guide</a> compares them.</p>
152155
<h3 id="configure-pulseaudio">Configure PulseAudio <a class="header-anchor" href="#configure-pulseaudio">#</a></h3>
@@ -208,7 +211,7 @@ <h2 id="things-with-no-toggle">Things with no toggle <a class="header-anchor" hr
208211
<nav class="doc-nav" aria-label="Pages"><a href="usage-android-app.html" class="doc-nav-prev"><small>Previous</small>Android app guide</a><a href="linux-cli.html" class="doc-nav-next"><small>Next</small>Linux CLI</a></nav>
209212
</main>
210213
<aside class="toc-column">
211-
<nav class="toc" aria-label="On this page"><p class="toc-title">On this page</p><ul><li class="toc-h2"><a href="#how-settings-are-stored">How settings are stored</a></li><li class="toc-h2"><a href="#networking">Networking</a></li><li class="toc-h3"><a href="#network-mode">Network Mode</a></li><li class="toc-h3"><a href="#static-ip-address">Static IP Address</a></li><li class="toc-h3"><a href="#upstream-interface">Upstream Interface</a></li><li class="toc-h3"><a href="#port-forwarding">Port Forwarding</a></li><li class="toc-h3"><a href="#disable-ipv6">Disable IPv6</a></li><li class="toc-h3"><a href="#dns-servers">DNS Servers</a></li><li class="toc-h2"><a href="#integration-and-hardware">Integration and hardware</a></li><li class="toc-h3"><a href="#android-storage">Android Storage</a></li><li class="toc-h3"><a href="#hardware-access">Hardware Access</a></li><li class="toc-h3"><a href="#gpu-access">GPU Access</a></li><li class="toc-h3"><a href="#configure-termuxx11">Configure Termux:X11</a></li><li class="toc-h3"><a href="#configure-virgl-3d-acceleration">Configure VirGL 3D Acceleration</a></li><li class="toc-h3"><a href="#configure-pulseaudio">Configure PulseAudio</a></li><li class="toc-h2"><a href="#resource-limits">Resource limits</a></li><li class="toc-h2"><a href="#security-and-boot">Security and boot</a></li><li class="toc-h3"><a href="#selinux-permissive">SELinux Permissive</a></li><li class="toc-h3"><a href="#allow-sandboxing">Allow Sandboxing</a></li><li class="toc-h3"><a href="#volatile-mode">Volatile Mode</a></li><li class="toc-h3"><a href="#force-cgroup-v1">Force Cgroup V1</a></li><li class="toc-h3"><a href="#privileged-mode">Privileged Mode</a></li><li class="toc-h3"><a href="#run-at-boot">Run at Boot</a></li><li class="toc-h2"><a href="#advanced-options">Advanced options</a></li><li class="toc-h3"><a href="#environment-variables">Environment Variables</a></li><li class="toc-h3"><a href="#bind-mounts">Bind Mounts</a></li><li class="toc-h3"><a href="#custom-init-binary">Custom Init Binary</a></li><li class="toc-h3"><a href="#termuxx11-extra-flags-and-virgl-extra-flags">Termux:X11 Extra Flags and VirGL Extra Flags</a></li><li class="toc-h2"><a href="#storage">Storage</a></li><li class="toc-h2"><a href="#things-with-no-toggle">Things with no toggle</a></li></ul></nav>
214+
<nav class="toc" aria-label="On this page"><p class="toc-title">On this page</p><ul><li class="toc-h2"><a href="#how-settings-are-stored">How settings are stored</a></li><li class="toc-h2"><a href="#networking">Networking</a></li><li class="toc-h3"><a href="#network-mode">Network Mode</a></li><li class="toc-h3"><a href="#static-ip-address">Static IP Address</a></li><li class="toc-h3"><a href="#upstream-interface">Upstream Interface</a></li><li class="toc-h3"><a href="#port-forwarding">Port Forwarding</a></li><li class="toc-h3"><a href="#disable-ipv6">Disable IPv6</a></li><li class="toc-h3"><a href="#dns-servers">DNS Servers</a></li><li class="toc-h2"><a href="#integration-and-hardware">Integration and hardware</a></li><li class="toc-h3"><a href="#android-storage">Android Storage</a></li><li class="toc-h3"><a href="#hardware-access">Hardware Access</a></li><li class="toc-h3"><a href="#gpu-access">GPU Access</a></li><li class="toc-h3"><a href="#configure-termuxx11">Configure Termux:X11</a></li><li class="toc-h3"><a href="#anland-display">Anland Display</a></li><li class="toc-h3"><a href="#configure-virgl-3d-acceleration">Configure VirGL 3D Acceleration</a></li><li class="toc-h3"><a href="#configure-pulseaudio">Configure PulseAudio</a></li><li class="toc-h2"><a href="#resource-limits">Resource limits</a></li><li class="toc-h2"><a href="#security-and-boot">Security and boot</a></li><li class="toc-h3"><a href="#selinux-permissive">SELinux Permissive</a></li><li class="toc-h3"><a href="#allow-sandboxing">Allow Sandboxing</a></li><li class="toc-h3"><a href="#volatile-mode">Volatile Mode</a></li><li class="toc-h3"><a href="#force-cgroup-v1">Force Cgroup V1</a></li><li class="toc-h3"><a href="#privileged-mode">Privileged Mode</a></li><li class="toc-h3"><a href="#run-at-boot">Run at Boot</a></li><li class="toc-h2"><a href="#advanced-options">Advanced options</a></li><li class="toc-h3"><a href="#environment-variables">Environment Variables</a></li><li class="toc-h3"><a href="#bind-mounts">Bind Mounts</a></li><li class="toc-h3"><a href="#custom-init-binary">Custom Init Binary</a></li><li class="toc-h3"><a href="#termuxx11-extra-flags-and-virgl-extra-flags">Termux:X11 Extra Flags and VirGL Extra Flags</a></li><li class="toc-h2"><a href="#storage">Storage</a></li><li class="toc-h2"><a href="#things-with-no-toggle">Things with no toggle</a></li></ul></nav>
212215
</aside>
213216
<footer class="footer">
214217
<div class="footer-inner">

‎docs/graphics-and-audio.html‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<a href="features.html" class="sidebar-link">Container settings</a>
6161
<a href="linux-cli.html" class="sidebar-link">Linux CLI</a>
6262
<a href="graphics-and-audio.html" class="sidebar-link" aria-current="page">Display, audio and desktop</a>
63+
<a href="anland.html" class="sidebar-link">Anland</a>
6364
<a href="kernel-configuration.html" class="sidebar-link">Kernel configuration</a>
6465
<a href="networking-from-zero.html" class="sidebar-link">Networking from zero</a>
6566
</details>
@@ -76,7 +77,7 @@
7677
<main id="main" class="docs-content">
7778
<article>
7879
<h1 id="display-audio-and-desktop">Display, audio and desktop <a class="header-anchor" href="#display-audio-and-desktop">#</a></h1>
79-
<p>On Android, Droidspaces starts the Termux:X11 display server, the VirGL server and the PulseAudio server for you when the matching toggles are on, and sets <code>DISPLAY</code>, <code>GALLIUM_DRIVER</code> and <code>PULSE_SERVER</code> inside the container. Turn on the toggles, start the container, and graphical programs open in the Termux:X11 app with sound from the phone's speaker. This page covers the one-time setup, the three ways to render, sound, a desktop that starts at boot, and the Linux side.</p>
80+
<p>On Android, Droidspaces starts the Termux:X11 display server, the VirGL server and the PulseAudio server for you when the matching toggles are on, and sets <code>DISPLAY</code>, <code>GALLIUM_DRIVER</code> and <code>PULSE_SERVER</code> inside the container. Turn on the toggles, start the container, and graphical programs open in the Termux:X11 app with sound from the phone's speaker. This page covers the one-time setup, the three ways to render, sound, a desktop that starts at boot, and the Linux side. For a Wayland desktop such as KDE Plasma there is a second path, covered on the <a href="anland.html">Anland</a> page.</p>
8081
<div class="callout callout-important"><strong class="callout-title">Important</strong><p>Droidspaces does not ship Termux:X11, VirGL or PulseAudio. They are Termux packages. Droidspaces starts and stops them and bridges their sockets into the container.</p></div>
8182
<h2 id="one-time-setup-on-android">One-time setup on Android <a class="header-anchor" href="#one-time-setup-on-android">#</a></h2>
8283
<ol>
@@ -209,11 +210,11 @@ <h2 id="linux">Linux <a class="header-anchor" href="#linux">#</a></h2>
209210
</ol>
210211
<p>Graphical programs started in the container then open on your desktop with hardware acceleration. Sound goes through the host's own PulseAudio or PipeWire socket if you bind-mount it; Droidspaces does not manage audio on Linux.</p>
211212
<hr />
212-
<p>Previous: <a href="linux-cli.html">Linux CLI</a> | Next: <a href="kernel-configuration.html">Kernel configuration</a></p>
213+
<p>Previous: <a href="linux-cli.html">Linux CLI</a> | Next: <a href="anland.html">Anland</a></p>
213214

214215
</article>
215216
<p class="doc-edit"><a href="https://github.com/ravindu644/Droidspaces-OSS/edit/main/Documentation/Graphics-and-Audio.md" rel="noopener noreferrer"><span class="icon" aria-hidden="true">edit</span>Edit this page on GitHub</a></p>
216-
<nav class="doc-nav" aria-label="Pages"><a href="linux-cli.html" class="doc-nav-prev"><small>Previous</small>Linux CLI</a><a href="kernel-configuration.html" class="doc-nav-next"><small>Next</small>Kernel configuration</a></nav>
217+
<nav class="doc-nav" aria-label="Pages"><a href="linux-cli.html" class="doc-nav-prev"><small>Previous</small>Linux CLI</a><a href="anland.html" class="doc-nav-next"><small>Next</small>Anland</a></nav>
217218
</main>
218219
<aside class="toc-column">
219220
<nav class="toc" aria-label="On this page"><p class="toc-title">On this page</p><ul><li class="toc-h2"><a href="#one-time-setup-on-android">One-time setup on Android</a></li><li class="toc-h2"><a href="#three-ways-to-render-on-android">Three ways to render on Android</a></li><li class="toc-h3"><a href="#llvmpipe">llvmpipe</a></li><li class="toc-h3"><a href="#virgl">VirGL</a></li><li class="toc-h3"><a href="#turnip">Turnip</a></li><li class="toc-h2"><a href="#sound-on-android">Sound on Android</a></li><li class="toc-h2"><a href="#a-desktop-that-starts-at-boot">A desktop that starts at boot</a></li><li class="toc-h2"><a href="#linux">Linux</a></li></ul></nav>

‎docs/index.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<a href="features.html" class="sidebar-link">Container settings</a>
6161
<a href="linux-cli.html" class="sidebar-link">Linux CLI</a>
6262
<a href="graphics-and-audio.html" class="sidebar-link">Display, audio and desktop</a>
63+
<a href="anland.html" class="sidebar-link">Anland</a>
6364
<a href="kernel-configuration.html" class="sidebar-link">Kernel configuration</a>
6465
<a href="networking-from-zero.html" class="sidebar-link">Networking from zero</a>
6566
</details>
@@ -86,6 +87,7 @@ <h2 id="guides">Guides</h2><ul>
8687
<li><a href="features.html">Container settings</a>: Every container setting in Droidspaces, in the order the app shows them: what each toggle or flag does, when to turn it on, and what it needs from the kernel.</li>
8788
<li><a href="linux-cli.html">Linux CLI</a>: Reference for the droidspaces command line: every command, every flag, and the config file keys.</li>
8889
<li><a href="graphics-and-audio.html">Display, audio and desktop</a>: GPU acceleration, PulseAudio sound and a desktop environment that starts on its own, for Droidspaces containers on Android and Linux.</li>
90+
<li><a href="anland.html">Anland</a>: A Wayland desktop on Android through Anland: install a patched compositor in the container, install the Anland app, and turn on Anland Display.</li>
8991
<li><a href="kernel-configuration.html">Kernel configuration</a>: How to build an Android kernel with Droidspaces support: the config options and patches for non-GKI and GKI kernels, and how to check the result.</li>
9092
<li><a href="networking-from-zero.html">Networking from zero</a>: Every networking concept behind Droidspaces gateway mode, from the start: IP addresses, LAN, WAN, DHCP, DNS, NAT, bridges, veth pairs, network namespaces and OpenWRT.</li>
9193
</ul>

‎docs/installation-android.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<a href="features.html" class="sidebar-link">Container settings</a>
6161
<a href="linux-cli.html" class="sidebar-link">Linux CLI</a>
6262
<a href="graphics-and-audio.html" class="sidebar-link">Display, audio and desktop</a>
63+
<a href="anland.html" class="sidebar-link">Anland</a>
6364
<a href="kernel-configuration.html" class="sidebar-link">Kernel configuration</a>
6465
<a href="networking-from-zero.html" class="sidebar-link">Networking from zero</a>
6566
</details>

‎docs/installation-linux.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<a href="features.html" class="sidebar-link">Container settings</a>
6161
<a href="linux-cli.html" class="sidebar-link">Linux CLI</a>
6262
<a href="graphics-and-audio.html" class="sidebar-link">Display, audio and desktop</a>
63+
<a href="anland.html" class="sidebar-link">Anland</a>
6364
<a href="kernel-configuration.html" class="sidebar-link">Kernel configuration</a>
6465
<a href="networking-from-zero.html" class="sidebar-link">Networking from zero</a>
6566
</details>

‎docs/kernel-configuration.html‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<a href="features.html" class="sidebar-link">Container settings</a>
6161
<a href="linux-cli.html" class="sidebar-link">Linux CLI</a>
6262
<a href="graphics-and-audio.html" class="sidebar-link">Display, audio and desktop</a>
63+
<a href="anland.html" class="sidebar-link">Anland</a>
6364
<a href="kernel-configuration.html" class="sidebar-link" aria-current="page">Kernel configuration</a>
6465
<a href="networking-from-zero.html" class="sidebar-link">Networking from zero</a>
6566
</details>
@@ -409,11 +410,11 @@ <h2 id="which-kernel-version-to-aim-for">Which kernel version to aim for <a clas
409410
<h2 id="where-to-ask">Where to ask <a class="header-anchor" href="#where-to-ask">#</a></h2>
410411
<p>Kernel questions get answered in the <a href="https://t.me/Droidspaces" rel="noopener noreferrer">Telegram channel</a>. The kernel's own option reference is the <a href="https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html" rel="noopener noreferrer">kernel documentation</a>.</p>
411412
<hr />
412-
<p>Previous: <a href="graphics-and-audio.html">Display, audio and desktop</a> | Next: <a href="cool-things-you-can-do.html">Recipes</a></p>
413+
<p>Previous: <a href="anland.html">Anland</a> | Next: <a href="cool-things-you-can-do.html">Recipes</a></p>
413414

414415
</article>
415416
<p class="doc-edit"><a href="https://github.com/ravindu644/Droidspaces-OSS/edit/main/Documentation/Kernel-Configuration.md" rel="noopener noreferrer"><span class="icon" aria-hidden="true">edit</span>Edit this page on GitHub</a></p>
416-
<nav class="doc-nav" aria-label="Pages"><a href="graphics-and-audio.html" class="doc-nav-prev"><small>Previous</small>Display, audio and desktop</a><a href="networking-from-zero.html" class="doc-nav-next"><small>Next</small>Networking from zero</a></nav>
417+
<nav class="doc-nav" aria-label="Pages"><a href="anland.html" class="doc-nav-prev"><small>Previous</small>Anland</a><a href="networking-from-zero.html" class="doc-nav-next"><small>Next</small>Networking from zero</a></nav>
417418
</main>
418419
<aside class="toc-column">
419420
<nav class="toc" aria-label="On this page"><p class="toc-title">On this page</p><ul><li class="toc-h2"><a href="#non-gki-kernels-318-to-419">Non-GKI kernels (3.18 to 4.19)</a></li><li class="toc-h3"><a href="#step-1-the-required-options">Step 1: The required options</a></li><li class="toc-h3"><a href="#step-2-firewall-support-optional">Step 2: Firewall support, optional</a></li><li class="toc-h3"><a href="#step-3-patches">Step 3: Patches</a></li><li class="toc-h3"><a href="#step-4-build-flash-check">Step 4: Build, flash, check</a></li><li class="toc-h2"><a href="#gki-kernels-54-and-newer">GKI kernels (5.4 and newer)</a></li><li class="toc-h3"><a href="#step-1-the-kabi-patches">Step 1: The kABI patches</a></li><li class="toc-h3"><a href="#step-2-edit-the-gki-defconfig">Step 2: Edit the GKI defconfig</a></li><li class="toc-h3"><a href="#step-3-build-flash-check">Step 3: Build, flash, check</a></li><li class="toc-h3"><a href="#cpu-and-process-limits-on-gki">CPU and process limits on GKI</a></li><li class="toc-h2"><a href="#what-the-check-looks-for">What the check looks for</a></li><li class="toc-h2"><a href="#which-kernel-version-to-aim-for">Which kernel version to aim for</a></li><li class="toc-h2"><a href="#where-to-ask">Where to ask</a></li></ul></nav>

‎docs/linux-cli.html‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
<a href="features.html" class="sidebar-link">Container settings</a>
6161
<a href="linux-cli.html" class="sidebar-link" aria-current="page">Linux CLI</a>
6262
<a href="graphics-and-audio.html" class="sidebar-link">Display, audio and desktop</a>
63+
<a href="anland.html" class="sidebar-link">Anland</a>
6364
<a href="kernel-configuration.html" class="sidebar-link">Kernel configuration</a>
6465
<a href="networking-from-zero.html" class="sidebar-link">Networking from zero</a>
6566
</details>
@@ -325,6 +326,11 @@ <h2 id="flags">Flags <a class="header-anchor" href="#flags">#</a></h2>
325326
<td><code>enable_pulseaudio</code></td>
326327
</tr>
327328
<tr>
329+
<td><code>--anland</code></td>
330+
<td>Android only, Wayland desktop through the Anland app</td>
331+
<td><code>enable_anland</code></td>
332+
</tr>
333+
<tr>
328334
<td><code>--enable-android-storage</code></td>
329335
<td>Android only</td>
330336
<td><code>enable_android_storage</code></td>

0 commit comments

Comments
 (0)