From 3958431f707521bb36321dc9a37e5db17d38b153 Mon Sep 17 00:00:00 2001 From: Anton Malinskiy Date: Tue, 13 Feb 2018 00:03:27 +0700 Subject: [PATCH] Create README.md --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e1cd58f --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +[![Build Status](https://travis-ci.org/agoda-com/docker-emulator-android.svg?branch=master)](https://travis-ci.org/agoda-com/docker-emulator-android) +[![Docker Stars](https://img.shields.io/docker/stars/agoda-com/docker-emulator-android.svg)]() +[![Docker Pulls](https://img.shields.io/docker/pulls/agoda-com/docker-emulator-android.svg)]() + +# docker-emulator-android +docker-emulator-android is one of the components of [android-farm](https://github.com/agoda-com/android-farm). It runs android emulator with hardware acceleration in a container. + +# Features +- Compatible with [OpenSTF](https://openstf.io) +- Optimized for performance + - hardware acceleration using KVM + - QEMU 2 +- Changing emulator spec is supported by + - overriding config.ini variables using `ANDROID_CONFIG` + - overriding emulator cmd args using `EMULATOR_OPTS` and `QEMU_OPTS` + - overriding adb ports using `CONSOLE_PORT (default 5554)`, `ADB_PORT (default 5555)` +- VNC server (port 5900) +- Google API's enabled + +# Usage +For example to run default emulator options with Marshmallow (API 23): +```console +$ docker run --privileged -v /dev/kvm:/dev/kvm agoda-com/docker-emulator-android-23:latest +$ adb connect VIP:5555 +``` + +If you want to start different configuration of device, for example a 7 inch tablet, you need to override `config.ini` variables: + +```console +$ docker run --privileged -e ANDROID_CONFIG="skin.name=600x1024;hw.lcd.density=160;hw.lcd.height=600;hw.lcd.width=1024;hw.device.name=7in WSVGA (Tablet);avd.ini.displayname=7 WSVGA (Tablet) API 23;" -v /dev/kvm:/dev/kvm agoda-com/docker-emulator-android-23:latest +``` + +For all the options available please check the [official documentation](https://developer.android.com/studio/run/emulator-commandline.html)