Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aind-containers/aind
AinD: Android in Docker. Ain't an emulator.
https://github.com/aind-containers/aind
Last synced: 3 months ago
JSON representation
AinD: Android in Docker. Ain't an emulator.
- Host: GitHub
- URL: https://github.com/aind-containers/aind
- Owner: aind-containers
- License: apache-2.0
- Archived: true
- Created: 2020-04-08T11:41:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-22T11:02:30.000Z (over 3 years ago)
- Last Synced: 2024-09-22T06:02:34.154Z (3 months ago)
- Language: Shell
- Size: 2.38 MB
- Stars: 1,491
- Watchers: 22
- Forks: 90
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-docker - aind - AinD launches Android apps in Docker, by nesting Anbox containers inside Docker by [@aind-containers](https://github.com/aind-containers) (Container Operations / Runtime)
README
# :warning: Deprecated in favor of ReDroid
As of April 2021, AinD is deprecated in favor of [ReDroid](https://github.com/remote-android/redroid-doc).
While Anbox/AinD has got stuck in Android 7.1, ReDroid supports very recent Android versions: 8.1, 9, 10, 11, and Android S (12).
- - -
# AinD: Android (Anbox) in Docker
AinD launches Android apps in Docker, by nesting [Anbox](https://anbox.io/) containers inside Docker.
Unlike VM-based similar projects, AinD can be executed on IaaS instances without support for nested virtualization.
GHCR: `ghcr.io/aind-containers/aind`
:warning: Docker Hub image [`aind/aind`](https://hub.docker.com/r/aind/aind) is no longer updated. Please use `ghcr.io/aind-containers/aind` image on GHCR.
## Purposes
* Anti-theft (see [FAQ](#faq))
* Android compatibility (via cloud) for iOS and Windows tablets
### Non-goals
* Cloud gaming
## Screenshots
```console
$ docker ps -a
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
950e3fa7d320 aind "/docker-entrypoint.…" 7 minutes ago Up 7 minutes 0.0.0.0:5900->5900/tcp aind
$ docker exec aind ps -ef | tail -n 20
101023 323 138 0 11:18 pts/2 00:00:00 /system/bin/sdcard -u 1023 -g 1023 -m -w /data/media emulated
110020 347 154 0 11:18 pts/2 00:00:00 com.android.systemui
101001 397 154 0 11:18 pts/2 00:00:00 com.android.phone
user 403 154 0 11:18 pts/2 00:00:00 com.android.settings:CryptKeeper
user 448 154 0 11:18 pts/2 00:00:00 com.android.settings
110009 531 154 0 11:18 pts/2 00:00:00 android.ext.services
110032 546 154 0 11:18 pts/2 00:00:00 com.android.deskclock
110015 577 154 0 11:18 pts/2 00:00:00 com.android.provision
110047 583 154 0 11:18 pts/2 00:00:00 com.android.smspush
110000 615 154 0 11:18 pts/2 00:00:00 org.anbox.appmgr
110011 642 154 0 11:18 pts/2 00:00:00 com.android.managedprovisioning
110008 657 154 0 11:18 pts/2 00:00:00 android.process.media
110003 675 154 0 11:18 pts/2 00:00:00 com.android.providers.calendar
110002 694 154 0 11:18 pts/2 00:00:00 android.process.acore
110027 744 154 0 11:18 pts/2 00:00:00 com.android.calendar
110028 765 154 0 11:18 pts/2 00:00:00 com.android.camera2
110034 784 154 0 11:18 pts/2 00:00:00 com.android.email
110037 807 154 0 11:18 pts/2 00:00:00 com.android.gallery3d
110013 822 154 0 11:18 pts/2 00:00:00 com.android.onetimeinitializer
root 1003 0 0 11:25 ? 00:00:00 ps -ef
```
## Quick start
Tested on Ubuntu 19.10 (Kernel 5.3).
May not work on other distros.
If `modprobe ashmem_linux` or `modprobe binder_linux` fails, see https://github.com/anbox/anbox-modules .
```bash
sudo modprobe ashmem_linux
sudo modprobe binder_linux
```
### Docker
#### VNC
```bash
docker run -td --name aind --privileged -p 5900:5900 -v /lib/modules:/lib/modules:ro ghcr.io/aind-containers/aind
docker exec aind cat /home/user/.vnc/passwdfile
```
> **NOTE**: `--privileged` is required for nesting an Anbox (LXC) inside Docker. But you don't need to worry too much because Anbox launches "unprivileged" LXC using user namespaces. You can confirm that all Android processes are running as non-root users, by executing `docker exec aind ps -ef`.
Wait for 10-20 seconds until Android processes are shown up in `docker exec aind ps -ef`, and then connect to `5900` via `vncviewer`.
The VNC password is stored in `/home/user/.vnc/passwdfile`. The password file can be also overridden by `docker run -v /your/own/passwdfile:/home/user/.vnc/passwdfile:ro` .
If the application manager doesn't shown up on the VNC screen, try `docker run ...` several times (FIXME). Also make sure to check `docker logs aind`.
#### Web mode (noVNC)
To run the container with [noVNC](https://novnc.com/) support, the environment variable `WEBMODE` can be set with the following command:
```bash
docker run -td --name aind --privileged -p 8080:8080 -e "WEBMODE=1" -v /lib/modules:/lib/modules:ro ghcr.io/aind-containers/aind
docker exec aind cat /home/user/.vnc/passwdfile
```
The container will be accessible via the browser at http://localhost:8080/vnc.html
### Docker Compose
To bring the container up simply run
```
docker-compose up -d
```
the vnc password can be gotten with
```
docker-compose exec aind cat /home/user/.vnc/passwdfile
```
you can check how far it is with
```
docker-compose exec aind ps -ef
```
### Kubernetes
```bash
kubectl apply -f kube/aind.yaml
kubectl port-forward service/aind 5900
```
The manifest contains the kernel module installer as `initContainers`.
The manifest is known to work on:
- Google Kubernetes Engine (GKE) 1.16.8-gke.8 (ubuntu) [Apr 14, 2020]
- Kubernetes 1.16.8, Ubuntu 18.04.4, Kernel 5.3.0-1012-gke, Docker 19.03.2
- n2-standard-8
- Google Kubernetes Engine (GKE) 1.16.8-gke.8 (ubuntu\_containerd) [Apr 14, 2020]
- Kubernetes 1.16.8, Ubuntu 18.04.4, Kernel 5.3.0-1012-gke, containerd 1.2.10
- n2-standard-8
- Azure Kubernetes Service (AKS) 1.17.3 [Apr 14, 2020]
- Kubernetes 1.17.3, Ubuntu 16.04.6, Kernel 4.15.0-1071-azure, MS-Moby 3.0.10+azure
- Standard DS2 v2
- kind 0.7.0 [Apr 14, 2020]
- Kubernetes 1.17.0, Ubuntu 19.10, Kernel 5.3.0-46-generic, containerd 1.3.2
- **NOTE**: Requires `docker exec kind-control-plane mount -o remount,rw /sys`
## Tips
### Troubleshooting
* `docker logs aind`
* `docker exec -it aind systemctl status anbox-container-manager`
* `docker exec -it aind ps -ef`
* `docker exec -it aind cat /var/lib/anbox/logs/console.log`
### adb
```bash
docker exec -it aind adb shell
```
To run adb on the host:
```
socat TCP-LISTEN:5037,reuseaddr,fork 'EXEC:docker exec -i aind "socat STDIO TCP-CONNECT:localhost:5037"' &
adb connect localhost:5037
adb shell
```
## Apps
### Pre-installed Apps
* Firefox
* F-Droid
* Misc accessories like Clock and Calculator
### Installing apk packages
APK files mounted as `/apk.d/*.apk` are automatically installed on start up.
You can also use [F-Droid](https://f-droid.org/).
To use F-Droid, enable "Settings" -> "Security" -> "Allow installation of apps from unknown sources".
## FAQ
### Isn't encrypting the phone with strong passcode enough for anti-theft? Why do we need aind?
People in the real world are likely to set weak passcode like "1234" (or finger pattern), because they want to open email/phone/twitter/maps/payment apps in just a few seconds.
aind is expected to be used in conjunction with encryption of the client device, and to be used only for sensitive apps, with a passcode that is stronger than the passcode of the client device itself.
## TODOs
* Map different UID range per containers
* Better touch screen experience
* Redirect camera, notifications, ...
## Similar projects
* [Anbox](https://anbox.io/): Desktop only and single-user/single-instance only. aind is built using Anbox.
* [Android container in Chrome OS](https://chromium.googlesource.com/chromiumos/platform2/+/master/arc/container-bundle/): ChromeOS/ChromiumOS-only
* [Docker-Android](https://github.com/budtmo/docker-android): VM-based
* [kubedroid](https://github.com/kubedroid/kubedroid): VM-based
* [Anbox Cloud](https://anbox-cloud.io/): Proprietary
* [Intel Celadon in Container (CIC)](https://github.com/projectceladon/device-intel-cic): [Proprietary](https://github.com/projectceladon/vendor-intel-cic/blob/9b91758a3fa0a6530910d0ada8e99816aa17195d/README)
## License
* aind itself (e.g. Dockerfile, Kubernetes manifests, and start-up scripts) is licensed under the terms of [the Apache License, Version 2.0](./LICENSE).
* The Anbox patches ([`./src/patches/anbox/*.patch`](./src/patches/anbox)) are licensed under the terms of [the GNU General Public License, Version 3](https://github.com/anbox/anbox/blob/master/COPYING.GPL), corresponding to [Anbox](https://github.com/anbox/anbox) itself.
### Binary image
* The `ghcr.io/aind-containers/aind` image on GitHub Container Registry (built from [`./Dockerfile`](./Dockerfile)) contains the binaries of several free software.
* Anbox (`/usr/local/bin/anbox`): [the GNU General Public License, Version 3](https://github.com/anbox/anbox/blob/master/COPYING.GPL)
* Firefox (`/apk-pre.d/fennec-*.apk`): [the Mozilla Public License 2](https://www.mozilla.org/en-US/about/legal/eula/)
* F-Droid (`/apk-pre.d/FDroid.apk`): [the GNU General Public License, Version 3](https://gitlab.com/fdroid/fdroidclient/-/blob/master/LICENSE)
* Android image (`/android.img`, fetched from https://build.anbox.io/): see https://source.android.com/setup/start/licenses . For build instruction, see https://github.com/anbox/anbox/blob/master/docs/build-android.md
* For other packages, see `/usr/share/doc/*/copyright` .