Skip to content

A rootless Android app that boots Alpine Linux: run containers (Podman/Docker/LXC) and GUI desktop apps.

docs(site): bring the guide up to date with v1.2.7

ExTva3e079d90435
diff --git a/docs/guide/backends.html b/docs/guide/backends.html
index 10162f9..2736c16 100644
--- a/docs/guide/backends.html
+++ b/docs/guide/backends.html
@@ -172,7 +172,7 @@
<a class="prev" href="performance.html"><span class="dir">Previous</span>&larr; Performance</a>
<a class="next" href="networking.html"><span class="dir">Next</span>Networking &amp; ports &rarr;</a>
</div>
- <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.5. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
+ <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.7. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
</main>
</div>
diff --git a/docs/guide/desktop.html b/docs/guide/desktop.html
index f1854d0..e4b5dd4 100644
--- a/docs/guide/desktop.html
+++ b/docs/guide/desktop.html
@@ -237,7 +237,7 @@ password=na</code></pre>
<a class="prev" href="packages.html"><span class="dir">Previous</span>← Packages &amp; services</a>
<a class="next" href="settings.html"><span class="dir">Next</span>Terminal &amp; settings →</a>
</div>
- <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.5. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
+ <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.7. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
</main>
</div>
diff --git a/docs/guide/getting-started.html b/docs/guide/getting-started.html
index c8c79a2..9dbcb5e 100644
--- a/docs/guide/getting-started.html
+++ b/docs/guide/getting-started.html
@@ -127,7 +127,7 @@
<a class="prev" href="index.html"><span class="dir">Previous</span>&larr; Overview</a>
<a class="next" href="how-it-works.html"><span class="dir">Next</span>How it works &rarr;</a>
</div>
- <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.5. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
+ <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.7. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
</main>
</div>
diff --git a/docs/guide/how-it-works.html b/docs/guide/how-it-works.html
index 169b9bf..ab433c5 100644
--- a/docs/guide/how-it-works.html
+++ b/docs/guide/how-it-works.html
@@ -143,7 +143,7 @@
<a class="prev" href="getting-started.html"><span class="dir">Previous</span>&larr; Getting started</a>
<a class="next" href="performance.html"><span class="dir">Next</span>Performance &amp; why it's slow &rarr;</a>
</div>
- <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.5. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
+ <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.7. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
</main>
</div>
diff --git a/docs/guide/index.html b/docs/guide/index.html
index b10a761..c48541c 100644
--- a/docs/guide/index.html
+++ b/docs/guide/index.html
@@ -81,7 +81,7 @@
<span></span>
<a class="next" href="getting-started.html"><span class="dir">Next</span>Getting started →</a>
</div>
- <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.5. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
+ <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.7. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
</main>
</div>
diff --git a/docs/guide/limitations.html b/docs/guide/limitations.html
index 164105d..d5f3ede 100644
--- a/docs/guide/limitations.html
+++ b/docs/guide/limitations.html
@@ -186,6 +186,9 @@
<h3>X11 is blurry or laggy</h3>
<p>The VNC client uses uncompressed Raw encoding (ZRLE is currently disabled), so high resolutions generate large frame payloads. Open the X11 viewer settings and pick a lower resolution preset (720p or 900p are good starting points). If you are on AVF, the latency should be much lower than on QEMU; on QEMU, latency will scale with how busy the TCG threads are.</p>
+ <h3>apk still reports the old Alpine version after an app update</h3>
+ <p>A guest that existed before v1.2.7 gets the new Alpine 3.24 files, because the system image is replaced on update, but its package database lives in the persistent overlay and still describes the previous release. Nothing is broken by it - the files really are the new ones - though <code>apk version -l "&lt;"</code> lists most of the base system as outdated and <code>apk add</code> may pull an older build of a package than it should. Running <code>apk upgrade</code> in the guest brings the database back in line, at the cost of writing a second copy of the base packages into the overlay. A VM created on v1.2.7 or later is unaffected.</p>
+
<h3>I changed RAM or CPU count and nothing happened</h3>
<p>RAM and CPU count are passed to QEMU at launch time and cannot be hot-changed. Stop the VM from the main screen, then start it again - the new values will be used. Port-forward rules and SSH toggle changes take effect without a restart.</p>
@@ -193,7 +196,7 @@
<a class="prev" href="settings.html"><span class="dir">Previous</span>&larr; Terminal &amp; settings</a>
<a class="next" href="use-cases.html"><span class="dir">Next</span>Use cases &rarr;</a>
</div>
- <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.5. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
+ <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.7. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
</main>
</div>
diff --git a/docs/guide/migrations.html b/docs/guide/migrations.html
index 229156c..a23e9b0 100644
--- a/docs/guide/migrations.html
+++ b/docs/guide/migrations.html
@@ -142,7 +142,7 @@ rc-update -u add my-service default</code></pre>
<a class="prev" href="packages.html"><span class="dir">Previous</span>&larr; Packages &amp; services</a>
<a class="next" href="desktop.html"><span class="dir">Next</span>Desktops &amp; X11 viewer &rarr;</a>
</div>
- <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.5. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
+ <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.7. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
</main>
</div>
diff --git a/docs/guide/networking.html b/docs/guide/networking.html
index f4de7d5..15721dd 100644
--- a/docs/guide/networking.html
+++ b/docs/guide/networking.html
@@ -218,17 +218,17 @@ podroid-server status</code></pre>
<p>Getting files in and out of the guest from another computer is a common first task, and which protocols can work is decided almost entirely by the privileged-port rule above. This section gives the one that works well, the one that works with a caveat, and the ones that cannot work at all, so you are not left testing them one by one.</p>
<h3>SFTP, the one to reach for first</h3>
- <p>SSH is already running on host port <code>9922</code>, so file transfer needs no second service and no extra rule. The guest ships dropbear without the SFTP helper binary, so install it once:</p>
-
- <pre><code><span class="c"># inside the VM</span>
-<span class="p">#</span> apk add openssh-sftp-server</code></pre>
-
- <p>That is the whole setup. Any SFTP client then connects to <code>&lt;phone-ip&gt;</code> on port <code>9922</code> with the guest's own credentials. WinSCP and FileZilla both speak it, as does the command line:</p>
+ <p>SSH is already running on host port <code>9922</code>, so file transfer needs no second service, no extra rule, and no setup at all: the guest ships the SFTP helper alongside dropbear. Turn SSH on in Settings and connect. Any SFTP client reaches <code>&lt;phone-ip&gt;</code> on port <code>9922</code> with the guest's own credentials. WinSCP and FileZilla both speak it, as does the command line:</p>
<pre><code><span class="p">$</span> sftp -P 9922 root@&lt;phone-ip&gt;</code></pre>
<p>It is encrypted, it needs one port instead of a range, and it goes through the rule the app already creates for you.</p>
+ <div class="callout note">
+ <span class="label">On an older VM image, one more line</span>
+ <p>The helper ships from v1.2.7 onwards. If <code>sftp</code> connects and then closes immediately, the image predates it: run <code>apk add openssh-sftp-server</code> in the guest once.</p>
+ </div>
+
<h3>FTP, when the client cannot do anything else</h3>
<p>Some old clients only speak FTP. It works, but passive mode needs care: the server tells the client which port to open for the data connection, so that port has to be forwarded too. Pin the passive range to a handful of ports rather than forwarding hundreds, and forward each one to the same number on both sides.</p>
@@ -285,7 +285,7 @@ pasv_addr_resolve=NO
<a class="prev" href="backends.html"><span class="dir">Previous</span>&larr; Backends: QEMU &amp; AVF</a>
<a class="next" href="packages.html"><span class="dir">Next</span>Packages &amp; services &rarr;</a>
</div>
- <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.5. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
+ <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.7. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
</main>
</div>
diff --git a/docs/guide/packages.html b/docs/guide/packages.html
index f18b75d..3102dc9 100644
--- a/docs/guide/packages.html
+++ b/docs/guide/packages.html
@@ -199,7 +199,7 @@
<a class="prev" href="networking.html"><span class="dir">Previous</span>&larr; Networking &amp; ports</a>
<a class="next" href="desktop.html"><span class="dir">Next</span>Desktops &amp; X11 viewer &rarr;</a>
</div>
- <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.5. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
+ <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.7. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
</main>
</div>
diff --git a/docs/guide/performance.html b/docs/guide/performance.html
index 501ad0c..069be6a 100644
--- a/docs/guide/performance.html
+++ b/docs/guide/performance.html
@@ -147,7 +147,7 @@
<a class="prev" href="how-it-works.html"><span class="dir">Previous</span>&larr; How it works</a>
<a class="next" href="backends.html"><span class="dir">Next</span>Backends: QEMU &amp; AVF &rarr;</a>
</div>
- <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.5. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
+ <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.7. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
</main>
</div>
diff --git a/docs/guide/settings.html b/docs/guide/settings.html
index 8c61714..8366776 100644
--- a/docs/guide/settings.html
+++ b/docs/guide/settings.html
@@ -148,7 +148,7 @@
<tr>
<td>Port forwards</td>
<td>Add / Remove</td>
- <td>Add TCP, UDP, or both forwarding rules. Changes apply live via QMP without a VM restart. Can also be managed from inside the VM with <code>podroid-forward</code> (see <a href="networking.html">Networking</a>).</td>
+ <td>Add TCP, UDP, or both forwarding rules. Changes apply live via QMP without a VM restart. Can also be managed from inside the VM with <code>podroid-forward</code> (see <a href="networking.html">Networking</a>). The rules the app manages itself - SSH, and the desktop's screen and audio channels - are listed above your own as read-only entries, so a port that is already taken is visible before you try to reuse it.</td>
</tr>
<tr>
<td>Bandwidth limit</td>
@@ -219,7 +219,7 @@
<a class="prev" href="desktop.html"><span class="dir">Previous</span>← Desktops &amp; X11 viewer</a>
<a class="next" href="limitations.html"><span class="dir">Next</span>Limitations &amp; troubleshooting →</a>
</div>
- <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.5. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
+ <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.7. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
</main>
</div>
diff --git a/docs/guide/use-cases.html b/docs/guide/use-cases.html
index b619a6c..a9ac83f 100644
--- a/docs/guide/use-cases.html
+++ b/docs/guide/use-cases.html
@@ -187,7 +187,7 @@
<a class="prev" href="limitations.html"><span class="dir">Previous</span>&larr; Limitations &amp; troubleshooting</a>
<span></span>
</div>
- <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.5. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
+ <p class="docfoot">Podroid is free software (GPL). Docs for v1.2.7. Found something inaccurate? <a href="https://github.com/ExTV/Podroid/issues">Open an issue</a>.</p>
</main>
</div>