Skip to content

Commit 352cf1d

Browse files
author
docs-bot
committed
docs: update from source@afb16a3
1 parent 6ec6876 commit 352cf1d

2 files changed

Lines changed: 53 additions & 7 deletions

File tree

docs/installation-android.html

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -415,15 +415,19 @@ <h2 id="step-1-install-the-app">Step 1: Install the App</h2>
415415
<h2 id="step-2-automatic-backend-setup">Step 2: Automatic Backend Setup</h2>
416416
<p>On the first launch, Droidspaces performs an <strong>Atomic Installation</strong> of the backend system: - It detects your device architecture (<code>aarch64</code>, <code>armhf</code>, etc.). - It extracts the <code>droidspaces</code> and <code>busybox</code> binaries to <code>/data/local/Droidspaces/bin</code>. - It performs an atomic move to ensure the binaries are installed correctly even if an older version is currently running. - It verifies checksums to ensure zero corruption.</p>
417417
<h2 id="step-3-setting-up-your-first-container">Step 3: Setting Up Your First Container</h2>
418-
<p>You don't need to manually extract rootfs files. The app handles it:</p>
418+
<p>You don't need to manually extract rootfs files. The app handles it all.</p>
419+
<h3 id="option-a-install-from-the-rootfs-repository-recommended">Option A: Install from the Rootfs Repository (Recommended)</h3>
420+
<p>The easiest way to get started. The app can browse, download, and install distros directly - no manual downloading required.</p>
419421
<ol>
420-
<li><strong>Download a rootfs tarball</strong>: We recommend using our <a href="https://github.com/ravindu644/Droidspaces-rootfs-builder/releases/latest" rel="noopener noreferrer">official rootfs tarballs</a> - which are <strong>specifically optimized for Android</strong> - or the official <a href="https://images.linuxcontainers.org/images/" rel="noopener noreferrer">Linux Containers images</a>.
421-
</li>
422422
<li><strong>Open the Containers Tab</strong>: Tap the middle icon in the bottom navigation bar.
423423
</li>
424-
<li><strong>Add a Container</strong>: Tap the <strong>"+"</strong> button at the bottom right.
424+
<li><strong>Open the Repository</strong>: Tap the <strong>cloud icon</strong> (above the "+" button). This opens the Rootfs Repository sheet, which automatically fetches all available distros optimized for Android from our <a href="https://github.com/Droidspaces/Droidspaces-rootfs-builder" rel="noopener noreferrer">official repository</a>.
425+
</li>
426+
<li><strong>Pick a distro</strong>: Browse or search the list. Each card shows the distro name, size, architecture, and build date.
425427
</li>
426-
<li><strong>Choose your Tarball</strong>: Select the downloaded <code>.tar.xz</code> or <code>.tar.gz</code> file.
428+
<li><strong>Download</strong>: Tap <strong>Download</strong> on the distro you want. A progress bar appears on the card. The file saves to your Downloads folder.
429+
</li>
430+
<li><strong>Install</strong>: Once complete, the button changes to <strong>Install</strong>. Tap it to launch the container setup wizard.
427431
</li>
428432
<li><strong>Configuration Wizard</strong>:
429433
<ul>
@@ -435,9 +439,21 @@ <h2 id="step-3-setting-up-your-first-container">Step 3: Setting Up Your First Co
435439
</li>
436440
</ul>
437441
</li>
438-
<li><strong>Installation</strong>: The app will extract the tarball and apply <strong>Post-Extraction Fixes</strong> automatically (DNS, Masking useless/dangerous services, and Safe Udev).
442+
<li><strong>Done</strong>: The app extracts the tarball and automatically applies <strong>Post-Extraction Fixes</strong> (DNS, masking useless/dangerous services, and Safe Udev).
443+
</li>
444+
</ol>
445+
<div class="callout callout-tip"><strong class="callout-title">TIP</strong> The official repository includes distros pre-configured for Android. For a wider selection, you can add the LXC images mirror as a custom repository - see the <a href="usage-android-app.html#rootfs-repository" rel="noopener noreferrer">Rootfs Repository</a> section of the Usage Guide.</div>
446+
<h3 id="option-b-install-from-a-local-tarball">Option B: Install from a Local Tarball</h3>
447+
<p>If you already have a <code>.tar.xz</code> or <code>.tar.gz</code> rootfs file on your device:</p>
448+
<ol>
449+
<li><strong>Open the Containers Tab</strong> and tap the <strong>"+"</strong> button.
450+
</li>
451+
<li><strong>Select your tarball</strong> from storage.
452+
</li>
453+
<li>Follow the same <strong>Configuration Wizard</strong> steps above.
439454
</li>
440455
</ol>
456+
<div class="callout callout-note"><strong class="callout-title">NOTE</strong> Both methods lead to the same wizard - the only difference is where the tarball comes from.</div>
441457
<h2 id="verification-settings">Verification & Settings</h2>
442458
<p>You can verify your system status at any time: 1. Go to <strong>Settings</strong> (gear icon) -> <strong>Requirements</strong>. 2. Tap <strong>Check Requirements</strong>. This runs the full <code>droidspaces check</code> suite internally. 3. <strong>Kernel Config</strong>: If you're a kernel developer, you can find a copyable <code>droidspaces.config</code> defconfig fragment, similar to <a href="./kernel-configuration.html#required-kernel-configuration" rel="noopener noreferrer">this page</a>, to make sure your kernel is perfectly compatible with Droidspaces.</p>
443459
<h2 id="next-steps">Next Steps</h2>

docs/usage-android-app.html

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,37 @@ <h2 id="containers-tab">Containers Tab</h2>
420420
<li><strong>Terminal Icon (Logs)</strong>: Provides access to persistent session logs for the container's previous start, stop, and restart sequences.
421421
</li>
422422
</ul>
423-
<div class="callout callout-tip"><strong class="callout-title">TIP</strong> You can <strong>edit container configuration</strong> or <strong>uninstall</strong> existing installed containers by <strong>pressing and holding</strong> the container's card. Also gives you the ability to migrate to a <code>rootfs.img</code>-based container or resize your existing <code>rootfs.img</code>..!</div>
423+
<div class="callout callout-tip"><strong class="callout-title">TIP</strong> You can <strong>edit container configuration</strong> or <strong>uninstall</strong> existing installed containers by <strong>pressing and holding</strong> the container’s card. Also gives you the ability to migrate to a <code>rootfs.img</code>-based container or resize your existing <code>rootfs.img</code>..!</div>
424+
<hr>
425+
<h2 id="rootfs-repository">Rootfs Repository</h2>
426+
<p>The <strong>cloud icon</strong> above the "+" button opens the Rootfs Repository - a built-in distro browser that lets you download and install Linux rootfs images without leaving the app.</p>
427+
<h3 id="how-it-works">How it works</h3>
428+
<ol>
429+
<li>Tap the <strong>cloud icon</strong> in the Containers tab.
430+
</li>
431+
<li>The sheet opens and loads available distros from the <a href="https://github.com/Droidspaces/Droidspaces-rootfs-builder" rel="noopener noreferrer">Droidspaces official repository</a>. Only images matching your device’s architecture are shown.
432+
</li>
433+
<li><strong>Search</strong> the list by name, description, or author using the search bar.
434+
</li>
435+
<li>Tap <strong>Download</strong> on a distro card. A progress bar tracks the download; the file is saved to your Downloads folder.
436+
</li>
437+
<li>Once done, the button switches to <strong>Install</strong>. Tap it to go straight into the container setup wizard.
438+
</li>
439+
</ol>
440+
<div class="callout callout-note"><strong class="callout-title">NOTE</strong> If a download fails, the card shows a <strong>Retry</strong> button. Previously downloaded files are detected automatically on relaunch - the Install button will already be available.</div>
441+
<h3 id="adding-custom-repositories">Adding Custom Repositories</h3>
442+
<p>The repository supports third-party rootfs sources in the same JSON format.</p>
443+
<ol>
444+
<li>Tap the <strong>settings icon</strong> (left of the refresh icon) in the sheet header.
445+
</li>
446+
<li>Enter a <strong>name</strong> and a <strong>URL</strong> pointing to a valid <code>rootfs.json</code>.
447+
</li>
448+
<li>Tap <strong>Add</strong>, then <strong>Save</strong>. The sheet refreshes and merges results from all sources.
449+
</li>
450+
</ol>
451+
<div class="callout callout-tip"><strong class="callout-title">TIP</strong> To get a much wider selection of distros, add the official LXC images mirror as a custom repository:
452+
- <strong>Name</strong>: anything you like (e.g. <code>LXC Mirror</code>)
453+
- <strong>URL</strong>: <code>https://raw.githubusercontent.com/Droidspaces/linuxcontainers-mirror/refs/heads/main/rootfs.json</code></div>
424454
<hr>
425455
<h2 id="networking-configuration">Networking Configuration</h2>
426456
<p>When editing or creating a container, you can choose from three networking modes:</p>

0 commit comments

Comments
 (0)