Usage Guide
使用教程
A quick tour of Droid Containers: from installing the app to pulling your first image and running your first container.
Droid 容器快速上手指南:从安装应用到拉取第一个镜像、运行第一个容器。
1. Requirements & Installation1. 设备要求与安装
- Android 8.0 (API 26) or later, arm64-v8a or x86_64 only — 32-bit devices are not supported.
- 需要 Android 8.0(API 26)及以上,仅支持 arm64-v8a 或 x86_64,不支持 32 位设备。
- Install “Droid Containers” from Google Play (package name
cn.yzapp.androidcontainer).
- 在 Google Play 安装「Droid 容器」(包名
cn.yzapp.androidcontainer)。
- On first launch, follow the setup guide to grant the app a battery-optimization exemption so containers can keep running in the background.
- 首次启动请按引导完成电池优化豁免授权,保证容器可以长期后台运行;部分厂商机型还需在系统设置里允许应用自启动。
2. Pull an Image2. 拉取镜像
- Open the Images tab and tap the pull button.
- 进入镜像页,点击拉取按钮。
- Enter an image reference, e.g.
python:3.12-slim, nginx:alpine, or alpine:latest.
- 输入镜像引用,例如
python:3.12-slim、nginx:alpine 或 alpine:latest。
- Watch the per-layer download progress. For private repositories, fill in your registry credentials first — they are stored locally on your device only.
- 查看逐层下载进度。如需拉取私有仓库镜像,请先填写仓库凭据——凭据仅保存在设备本地。
Tip: slim/alpine variants download much faster and use far less storage on phones.
提示:slim / alpine 精简版镜像下载更快,在手机上也更省存储空间。
3. Create & Start a Container3. 创建并启动容器
- Go to the Containers tab and create a new container from a pulled image, setting the name, entry command, and port mappings as needed.
- 进入容器页,基于已拉取的镜像创建新容器,按需设置名称、启动命令和端口映射。
- Tap start. The container runs in a user-space environment (proot) — no root required — and a foreground service keeps it alive in the background.
- 点击启动。容器在用户态环境(proot)中运行——无需 root——并由前台服务托管保持后台运行。
- You can run multiple containers at the same time, or use the Compose tab to bring up multi-service stacks from a compose file.
- 可以同时运行多个容器,也可以在编排页通过 compose 文件一键启动多服务组合。
Tip: keep the app’s foreground notification active. If your ROM aggressively kills background apps (MIUI, EMUI, ColorOS…), also enable autostart and lock the app in Recents.
提示:请保持应用前台通知开启。如果系统会激进杀后台(MIUI、EMUI、ColorOS 等),建议同时开启自启动权限并在最近任务中锁定应用。
4. Logs, Exec & Troubleshooting4. 日志、命令与排障
- Open a container’s Logs view to see what it printed — this is the first place to look when something does not work.
- 打开容器的日志查看输出——出问题时先看这里。
- Use Exec to run commands inside a running container, for example
python --version or ls /etc.
- 通过命令执行在运行中的容器里执行命令,例如
python --version 或 ls /etc。
- If a service should be reachable from outside, check its port mapping in the container settings and test with your phone’s browser, e.g.
http://127.0.0.1:8080.
- 如果服务需要从外部访问,请在容器设置中确认端口映射,并用手机浏览器测试,例如
http://127.0.0.1:8080。
- Stopping a container gracefully terminates its processes first (SIGTERM, then SIGKILL); stop is idempotent, so it is safe to tap again.
- 停止容器会先优雅终止进程(先 SIGTERM 再 SIGKILL),停止操作可重复点击,是幂等安全的。
5. Feedback & Support5. 反馈与支持
Found a bug, or want a feature? Two ways to reach us:
发现问题或想要新功能?两种方式联系我们:
When reporting a problem, please include your device model, Android version, the image name, and the container log output — it makes diagnosis much faster.
反馈问题时请附上设备型号、Android 版本、镜像名称以及容器日志输出,这样能更快定位问题。