Skip to content

Commit afb16a3

Browse files
ravindu644ravindu644
committed
docs: update installation and usage guides to include Rootfs Repository features
Signed-off-by: ravindu644 <droidcasts@protonmail.com>
1 parent 8c2be2d commit afb16a3

4 files changed

Lines changed: 117 additions & 15 deletions

File tree

‎Documentation/Installation-Android.md‎

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,38 @@ On the first launch, Droidspaces performs an **Atomic Installation** of the back
3131

3232
## Step 3: Setting Up Your First Container
3333

34-
You don't need to manually extract rootfs files. The app handles it:
34+
You don't need to manually extract rootfs files. The app handles it all.
3535

36-
1. **Download a rootfs tarball**: We recommend using our [official rootfs tarballs](https://github.com/ravindu644/Droidspaces-rootfs-builder/releases/latest) - which are **specifically optimized for Android** - or the official [Linux Containers images](https://images.linuxcontainers.org/images/).
37-
2. **Open the Containers Tab**: Tap the middle icon in the bottom navigation bar.
38-
3. **Add a Container**: Tap the **"+"** button at the bottom right.
39-
4. **Choose your Tarball**: Select the downloaded `.tar.xz` or `.tar.gz` file.
40-
5. **Configuration Wizard**:
36+
### Option A: Install from the Rootfs Repository (Recommended)
37+
38+
The easiest way to get started. The app can browse, download, and install distros directly - no manual downloading required.
39+
40+
1. **Open the Containers Tab**: Tap the middle icon in the bottom navigation bar.
41+
2. **Open the Repository**: Tap the **cloud icon** (above the "+" button). This opens the Rootfs Repository sheet, which automatically fetches all available distros optimized for Android from our [official repository](https://github.com/Droidspaces/Droidspaces-rootfs-builder).
42+
3. **Pick a distro**: Browse or search the list. Each card shows the distro name, size, architecture, and build date.
43+
4. **Download**: Tap **Download** on the distro you want. A progress bar appears on the card. The file saves to your Downloads folder.
44+
5. **Install**: Once complete, the button changes to **Install**. Tap it to launch the container setup wizard.
45+
6. **Configuration Wizard**:
4146
- **Name**: Give your container a friendly name.
4247
- **Features**: Toggle Hardware Access, IPv6, Network Isolation, Android storage integration, etc., according to your needs.
4348
- **Container Type**: We recommend **Sparse Image** for better performance and stability on Android’s f2fs storage, as well as to prevent weird SELinux/Keyring issues.
44-
6. **Installation**: The app will extract the tarball and apply **Post-Extraction Fixes** automatically (DNS, Masking useless/dangerous services, and Safe Udev).
49+
7. **Done**: The app extracts the tarball and automatically applies **Post-Extraction Fixes** (DNS, masking useless/dangerous services, and Safe Udev).
50+
51+
> [!TIP]
52+
>
53+
> 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 [Rootfs Repository](Usage-Android-App.md#rootfs-repository) section of the Usage Guide.
54+
55+
### Option B: Install from a Local Tarball
56+
57+
If you already have a `.tar.xz` or `.tar.gz` rootfs file on your device:
58+
59+
1. **Open the Containers Tab** and tap the **"+"** button.
60+
2. **Select your tarball** from storage.
61+
3. Follow the same **Configuration Wizard** steps above.
62+
63+
> [!NOTE]
64+
>
65+
> Both methods lead to the same wizard - the only difference is where the tarball comes from.
4566
4667
## Verification & Settings
4768

‎Documentation/Usage-Android-App.md‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,39 @@ This tab allows you to install containers using the "+" icon, and lists all your
3030

3131
> [!TIP]
3232
>
33-
> You can **edit container configuration** or **uninstall** existing installed containers by **pressing and holding** the container's card. Also gives you the ability to migrate to a `rootfs.img`-based container or resize your existing `rootfs.img`..!
33+
> You can **edit container configuration** or **uninstall** existing installed containers by **pressing and holding** the container’s card. Also gives you the ability to migrate to a `rootfs.img`-based container or resize your existing `rootfs.img`..!
34+
35+
---
36+
37+
## Rootfs Repository
38+
39+
The **cloud icon** 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.
40+
41+
### How it works
42+
43+
1. Tap the **cloud icon** in the Containers tab.
44+
2. The sheet opens and loads available distros from the [Droidspaces official repository](https://github.com/Droidspaces/Droidspaces-rootfs-builder). Only images matching your device’s architecture are shown.
45+
3. **Search** the list by name, description, or author using the search bar.
46+
4. Tap **Download** on a distro card. A progress bar tracks the download; the file is saved to your Downloads folder.
47+
5. Once done, the button switches to **Install**. Tap it to go straight into the container setup wizard.
48+
49+
> [!NOTE]
50+
>
51+
> If a download fails, the card shows a **Retry** button. Previously downloaded files are detected automatically on relaunch - the Install button will already be available.
52+
53+
### Adding Custom Repositories
54+
55+
The repository supports third-party rootfs sources in the same JSON format.
56+
57+
1. Tap the **settings icon** (left of the refresh icon) in the sheet header.
58+
2. Enter a **name** and a **URL** pointing to a valid `rootfs.json`.
59+
3. Tap **Add**, then **Save**. The sheet refreshes and merges results from all sources.
60+
61+
> [!TIP]
62+
>
63+
> To get a much wider selection of distros, add the official LXC images mirror as a custom repository:
64+
> - **Name**: anything you like (e.g. `LXC Mirror`)
65+
> - **URL**: `https://raw.githubusercontent.com/Droidspaces/linuxcontainers-mirror/refs/heads/main/rootfs.json`
3466
3567
---
3668

‎Documentation/zh-CN/Installation-Android.md‎

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,36 @@ Droidspaces 在 Android 上旨在提供"零终端"体验。从首次安装到运
3131

3232
## 第 3 步：设置你的第一个容器
3333

34-
你无需手动解压 rootfs 文件。应用会处理一切：
34+
你无需手动解压 rootfs 文件。应用会全程处理。
3535

36-
1. **下载 rootfs tarball**：我们推荐使用我们的[官方 rootfs tarball](https://github.com/ravindu644/Droidspaces-rootfs-builder/releases/latest)——这些是**专门为 Android 优化过的**——或官方的 [Linux Containers 镜像](https://images.linuxcontainers.org/images/)。
37-
2. **打开容器选项卡**：点击底部导航栏中的中间图标。
38-
3. **添加容器**：点击右下角的 **"+"** 按钮。
39-
4. **选择你的 Tarball**：选择下载的 `.tar.xz` 或 `.tar.gz` 文件。
40-
5. **配置向导**：
36+
### 方式 A：从 Rootfs 仓库安装（推荐）
37+
38+
最简单的上手方式。应用可以直接浏览、下载并安装发行版，无需手动下载任何文件。
39+
40+
1. **打开容器选项卡**：点击底部导航栏中的中间图标。
41+
2. **打开仓库**：点击 **云图标**（位于"+"按钮上方）。这将打开 Rootfs 仓库面板，自动从我们的[官方仓库](https://github.com/Droidspaces/Droidspaces-rootfs-builder)获取所有适配 Android 的可用发行版。
42+
3. **选择发行版**：浏览或搜索列表。每张卡片显示发行版名称、大小、架构和构建日期。
43+
4. **下载**：点击你想要的发行版卡片上的 **下载** 按钮。卡片上会出现进度条，文件将保存到你的下载文件夹。
44+
5. **安装**：下载完成后，按钮会变为 **安装**。点击它以启动容器设置向导。
45+
6. **配置向导**：
4146
- **名称**：为你的容器起一个友好的名称。
4247
- **功能**：根据需要切换硬件加速、IPv6、网络隔离、Android 存储集成等。
4348
- **容器类型**：我们推荐使用**稀疏镜像**，以便在 Android 的 f2fs 存储上获得更好的性能和稳定性，同时避免奇怪的 SELinux/Keyring 问题。
44-
6. **安装**：应用将解压 tarball 并自动应用**解压后修复**（DNS、屏蔽无用/危险的服务以及安全 Udev）。
49+
7. **完成**：应用将解压 tarball 并自动应用**解压后修复**（DNS、屏蔽无用/危险的服务以及安全 Udev）。
50+
51+
> [!TIP]
52+
> 官方仓库包含专为 Android 预配置的发行版。如需更多选择，你可以将 LXC 镜像作为自定义仓库添加——详见使用指南中的 [Rootfs 仓库](./Usage-Android-App.md#rootfs-repository) 章节。
53+
54+
### 方式 B：从本地 Tarball 安装
55+
56+
如果你的设备上已有 `.tar.xz` 或 `.tar.gz` 格式的 rootfs 文件：
57+
58+
1. **打开容器选项卡**，点击 **"+"** 按钮。
59+
2. 从存储中**选择你的 tarball 文件**。
60+
3. 按照上述相同的**配置向导**步骤操作即可。
61+
62+
> [!NOTE]
63+
> 两种方式最终都会进入同一个向导——唯一的区别是 tarball 的来源不同。
4564
4665
## 验证与设置
4766

‎Documentation/zh-CN/Usage-Android-App.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,36 @@ Droidspaces 的 Android 应用为管理 Linux 容器提供了精美的图形界
3434
3535
---
3636

37+
## Rootfs 仓库
38+
39+
容器选项卡中 "+" 按钮上方的**云图标**可打开 Rootfs 仓库——一个内置的发行版浏览器，让你无需离开应用即可下载和安装 Linux rootfs 镜像。
40+
41+
### 使用方法
42+
43+
1. 点击容器选项卡中的**云图标**。
44+
2. 面板打开后，会从 [Droidspaces 官方仓库](https://github.com/Droidspaces/Droidspaces-rootfs-builder) 加载可用发行版，仅显示与你设备架构匹配的镜像。
45+
3. 使用搜索栏按名称、描述或作者**搜索**列表。
46+
4. 在发行版卡片上点击**下载**。进度条会实时显示下载进度，文件保存到你的下载文件夹。
47+
5. 下载完成后，按钮切换为**安装**。点击它即可直接进入容器设置向导。
48+
49+
> [!NOTE]
50+
> 如果下载失败，卡片上会显示**重试**按钮。重新启动应用时，之前已下载的文件会被自动识别——安装按钮将直接可用。
51+
52+
### 添加自定义仓库
53+
54+
仓库支持使用相同 JSON 格式的第三方 rootfs 来源。
55+
56+
1. 点击面板头部的**设置图标**（刷新图标左侧）。
57+
2. 输入**名称**和指向有效 `rootfs.json` 的 **URL**。
58+
3. 点击**添加**，然后点击**保存**。面板将刷新并合并所有来源的结果。
59+
60+
> [!TIP]
61+
> 如需获得更丰富的发行版选择，可将官方 LXC 镜像源添加为自定义仓库：
62+
> - **名称**：随意填写（例如 `LXC Mirror`）
63+
> - **URL**：`https://raw.githubusercontent.com/Droidspaces/linuxcontainers-mirror/refs/heads/main/rootfs.json`
64+
65+
---
66+
3767
## 网络配置
3868

3969
在编辑或创建容器时，你可以从三种网络模式中进行选择：

0 commit comments

Comments
 (0)