PlenusPyramis Android SDK in Docker

This is a fork of thyrlian/AndroidSDK. This sets up an environment to develop and build android apps inside of a preconfigured docker container.

This README is a supplement to the original, which has been copied to README-UPSTREAM.md

What follows is abbreviated steps to install/start/stop/destroy the plenuspyramis/android-sdk docker container.

Setup

Download and install android-studio. You will use Android Studio to download SDKs to the default directory on your host: $HOME/Android/Sdk. This directory will be mounted into the docker container at /sdk (read-only) so as to share the same SDKs as you have on your host.
Ensure your user account has sudo priviliges.
Put this in your $HOME/.bashrc. This wraps all the docker commands into reusable bash aliases. Ensure you change ANDROID_DOCKER to a real path on your host where you have this repository cloned:

# Android Docker Config:
# https://www.github.com/plenuspyramis/AndroidSDK
## Set ANDROID_DOCKER to your clone of plenuspyramis/AndroidSDK
export ANDROID_DOCKER=$HOME/git/vendor/plenuspyramis/AndroidSDK
export ANDROID_DOCKER_IMAGE=plenuspyramis/android-sdk
export ANDROID_DOCKER_CONTAINER=android-docker
export ANDROID_STUDIO_SDK=$HOME/Android/Sdk
export ANDROID_DOCKER_EMULATOR_PLATFORM=24
export ANDROID_DOCKER_EMULATOR_ARCH=x86
alias android-docker-start='if sudo docker ps -a | grep $ANDROID_DOCKER_CONTAINER > /dev/null; then sudo docker start $ANDROID_DOCKER_CONTAINER; else sudo docker run -d --privileged --name $ANDROID_DOCKER_CONTAINER -v $ANDROID_STUDIO_SDK:/sdk:ro -v $ANDROID_DOCKER/gradle_caches:/home/android/.gradle/caches -p 127.0.0.1:5901:5901 $ANDROID_DOCKER_IMAGE; fi;'
alias android-docker-stop='sudo docker stop $ANDROID_DOCKER_CONTAINER'
alias android-docker-destroy='sudo docker rm $ANDROID_DOCKER_CONTAINER'
alias android-docker-shell='sudo docker exec -it $ANDROID_DOCKER_CONTAINER /bin/bash'
alias android-docker-vnc='if ! which vncviewer > /dev/null; then echo "You must install vncviewer" && exit 1; else vncviewer 127.0.0.1:1; fi'
alias android-docker-emulator-config='$ANDROID_STUDIO_SDK/tools/bin/sdkmanager "platform-tools" "platforms;android-$ANDROID_DOCKER_EMULATOR_PLATFORM" "emulator" "system-images;android-$ANDROID_DOCKER_EMULATOR_PLATFORM;default;$ANDROID_DOCKER_EMULATOR_ARCH" && echo "no" | $ANDROID_STUDIO_SDK/tools/bin/avdmanager create avd -n test -k "system-images;android-$ANDROID_DOCKER_EMULATOR_PLATFORM;default;$ANDROID_DOCKER_EMULATOR_ARCH" && echo -e "\nAVD created."'

Once you have saved $HOME/.bashrc, restart your terminal to reload it.

Command reference:

android-docker-start - Start/Create the android-docker container. (The name is configurable by setting ANDROID_DOCKER_CONTAINER, see above.)
android-docker-stop - Stop the container.
android-docker-shell - Connect to a shell inside the running container.
android-docker-vnc - Connect to the vnc server running in the container (must have vncviewer installed on host.) Default password is android. You can change the vnc password by creating your own image and using the VNC_PASSWORD and VNC_PASSWORD_VIEW_ONLY build arguments.
android-docker-destroy - destroy the stopped container. (add -f to stop and destroy the running container.)

Mini Android Development Tutorial

Download all the things you need to run an emulator:

Run this on your host, to download Android platform 24 for x86:

Building images

If you want to use the plenuspyramis/android-sdk image from the docker hub, skip this section. This section will help you build your own images if you need to make customizations.

This fork of thyrlian/android-sdk is reworked to run as the android user instead of root. Sudo priviliges are granted to the android user, so you can still do everything that still needs root. This fixes file permissions for sharing files between the host and container.

There is a single multi-stage Dockerfile to build the base image and the vnc server image.

Build the image:

sudo docker build -t android-sdk:local \
  --build-arg USER_ID=$UID \
  --build-arg VNC_PASSWORD=android \
  --build-arg VNC_PASSWORD_VIEW_ONLY=docker \
  $ANDROID_DOCKER/android-sdk

The USER_ID argument is necessary to fix permissions for files mounted from the host to the container. $UID is your current host user account's user id (check it by running echo $UID). Your user id is usually 1000 on a computer with only one user account. Passing --build-arg USER_ID=$UID into the build command will ensure the image is built giving the android user inside the container the same user id as that of your user account on the host.

VNC_PASSWORD and VNC_PASSWORD_VIEW_ONLY are used to set the passwords for the vnc server.

Your new customized image will be called android-sdk:local. Update the ANDROID_DOCKER_IMAGE variable that you earlier put in your $HOME/.bashrc, change it from plenuspyramis/android-sdk to android-sdk:local.

Make sure you reload your terminal session to reload the aliases from $HOME/.bashrc.

Run android-docker-destroy to delete the old container.

Finally, run android-docker-start to create a new container using your new image.

PlenusPyramis / AndroidSDK