Android/redroid-doc
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refine

Browse Source
This commit is contained in:
Ziyang Zhou
2020-12-17 22:18:35 +08:00
parent ce1cc1fd08
commit 319884292f
15 changed files with 194 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
README.md
View File

@@ -4,24 +4,26 @@ English | [简体中文](zh/)
**ReDroid** (Remote Android) is a lightweight GPU accelerated Android Emulator. You can boot many
instances in Linux host or any Linux container envrionments (`Docker`, `K8S`, `LXC` etc.).
*ReDroid* supports both arm64 and x86_64 architectures. You can connect to *ReDroid* througth
`VNC` or `WebRTC` (TODO) or `adb` shell. *ReDroid* is suitable for Cloud Gaming,
`VNC` or `WebRTC` (TODO) or `adb shell`. *ReDroid* is suitable for Cloud Gaming,
VDI / VMI (Virtual Mobile Infurstrure), Automation Test and more.
Currently supported Android version:
- Android 8 (GPU enabled)
- Android 9 (GPU enabled)
- Android 10 (ongoing)
Currently supported:
- Android 11 (`redroid/redroid:11.0.0-latest`, `redroid/redroid:11.0.0-amd64`, `redroid/redroid:11.0.0-arm64`)
- Android 10 (`redroid/redroid:10.0.0-latest`, `redroid/redroid:10.0.0-amd64`, `redroid/redroid:10.0.0-arm64`)
- Android 9 (`redroid/redroid:9.0.0-latest`, `redroid/redroid:9.0.0-amd64`, `redroid/redroid:9.0.0-arm64`)
- Android 8.1 (`redroid/redroid:8.1.0-latest`, `redroid/redroid:8.1.0-amd64`, `redroid/redroid:8.1.0-arm64`)
## Quick Start
*ReDroid* runs on modern linux (kernel 4.14+), and require some Android specific modules (binder, ashmem at least)
check [kernel modules](https://github.com/remote-android/redroid-modules) for more.
## Quick Started via Docker
*ReDroid* runs on modern linux (currently require kernel version 4.14+), and require some Android specific
drivers (binder, ashmem at least) check [kernel modules](https://github.com/remote-android/redroid-modules)
for more details.
```bash
# quick install kernel driver via docker, change *NODE_OS* to actual OS (ubuntu:18.04 for example)
docker run --cap-add CAP_SYS_MODULE <NODE_OS> --entrypoint bash <(curl -s https://raw.githubusercontent.com/remote-android/redroid-modules/master/deploy/build.sh)
# install kernel modules
sudo bash -c "`curl -s https://raw.githubusercontent.com/remote-android/redroid-modules/master/deploy/build.sh`"
# start a ReDroid instance via docker
docker run -v ~/data:/data -itd -p 5900:5900 -p 5555:5555 --rm --memory-swappiness=0 --privileged redroid/redroid
# start ReDroid instance
docker run -v ~/data:/data -itd -p 5900:5900 -p 5555:5555 --rm --memory-swappiness=0 --privileged redroid/redroid:10.0.0-latest
## explains:
## -v ~/data:/data -- mount data partition
@@ -32,21 +34,21 @@ docker run -v ~/data:/data -itd -p 5900:5900 -p 5555:5555 --rm --memory-swappine
## Start Params
required params (already added in image args)
- qemu=1
- androidboot.hardware=goldfish
- androidboot.hardware=redroid
display params
- redroid.width=720
- redroid.height=1280
- redroid.density=320
- redroid.fps=15
- ro.sf.lcd_density=320
GPU accelerating
*ReDroid* use mesa3d to accelerate 3D rendering.
- qemu.gles.vendor=mesa
- ro.hardware.gralloc=[minigbm|minigbm_intel]
- ro.hardware.gralloc=minigbm
you can override system props prefixed with `qemu.` or `ro.`. for example, you can set `ro.secure=0`, then
you can get root adb shell.
you can get root adb shell by default.
## Deployment
*ReDroid* support different deploy methods, check [Deploy](./deploy.md) for more details.
@@ -57,33 +59,48 @@ you can get root adb shell.
- Package Manager
## Native Bridge
It's possible to run Arm Apps in x86 *ReDroid* instance with `libhoudini`, `ARM translater` or `Qemu translater`
check [Native Bridge](./native_bridge.md) for more details.
It's possible to run Arm Apps in x64 *ReDroid* instance with `libhoudini`, `libndk_translator` or `Qemu translater`
Check [Native Bridge](./native_bridge) for more.
## GMS
It's possible to add GMS (Google Mobile Service) support in *ReDroid* instance via Google packages or `MicroG`.
check [GMS](./gms.md) for more details.
It's possible to add GMS (Google Mobile Service) support in *ReDroid* via Google packages or `MicroG`.
Check [GMS](./gms.md) for more.
## WebRTC
Compared with RFB (VNC), WebRTC is more versatile (audio / video / camera support...).
*ReDroid* is planning to implement WebRTC protocol. Check [WebRTC](./webrtc.md) for more details.
Compared with `RFB` (VNC), `WebRTC` is more versatile (audio / video / camera / sensors data...).
*ReDroid* is planning to implement `WebRTC` protocol. Check [WebRTC](./webrtc.md) for more.
## Build
1. setup build environment, check [AOSP setup](https://source.android.com/setup/build/initializing#installing-required-packages-ubuntu-1404)
section. Suggest build with [docker](https://android.googlesource.com/platform/build/+/master/tools/docker)
2. `repo init https://github.com/remote-android/platform_manifests.git -b redroid-8.1.0` (you can change to other branches, such as
redroid-9.0.0, redroid-10.0.0)
3. `. build/envsetup.sh && lunch`
4. choose `redroid_x86_64-userdebug` or `redroid_arm64-userdebug`
5. run `m` to build all
Same as AOSP building process. check [AOSP setup](https://source.android.com/setup/build/initializing#installing-required-packages-ubuntu-1404)
Check [ReDroid build](./build.md) for more.
## Troubleshooting
- cannot connect to network (cannot `ping`)
- `adb shell boot_completed.redroid.sh`
- VNC screen hang
- try `stop vncserver && start vncserver`
- or reboot *ReDroid* instance `docker restart ...`
- icon in launcher gone
- if switching between GPU / swiftshader (soft), try to clear launcher data or entire data partition
- `fuse` setup failed
- try `modprobe fuse`
## Contributing
Contributing is always welcome (especially the `HAL` part). Please make minimal changes to AOSP code.
Contributing is always welcome (especially the `HAL` part). check [Contributing](./contributing.md) for more
## Workarounds
- SElinux is disabled in *ReDroid*; check [selinuxns POC](http://namei.org/presentations/selinux_namespacing_lca2018.pdf)
- sdcardfs currently not implemented as modules, use `fuse` instead;
- SElinux is disabled in *ReDroid*; possible enabled with [selinuxns POC](http://namei.org/presentations/selinux_namespacing_lca2018.pdf)
- sdcardfs currently not implemented, use `fuse` instead; may need run `modprobe fuse` first in some OS (AmazonLinux2?)
- CGroups errors ignored; some cgroups path not same with generic linux, and some (`stune` for example) not supported
- `procfs` not fully seperated with host OS; community use `lxcfs` and some cloud vendor ([TencentOS](https://github.com/Tencent/TencentOS-kernel)) enhanced in their own kernel.
- vintf verify disabled (since no kernel)
## License
*ReDroid* itself is under [Apache License](https://www.apache.org/licenses/LICENSE-2.0), since *ReDroid* includes
many 3rd party modules, you may need to examine license carefully.
*ReDroid* kernel modules are under [GPL v2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)