Skip to content

Latest commit

 

History

History
225 lines (154 loc) · 8.43 KB

README.md

File metadata and controls

225 lines (154 loc) · 8.43 KB
Raw

docker-adb

This repository contains a Dockerfile for the Android Debug Bridge. It gives you access to platform tools such as adb and fastboot.

Changes

Android platform tools are automatically updated to the latest stable version on each docker image build.

  • 2024-09-21 Platform tools updated to 35.0.2
  • 2024-03-26 Platform tools updated to 35.0.1, alpine to 3.18.6
  • 2023-12-13 Alpine updated to 3.18.5
  • 2023-10-20 Platform tools updated to 34.0.5
  • 2023-08-08 Platform tools updated to 34.0.4, glibc to 2.35-r1, alpine to 3.18.3
  • 2023-05-28 Platform tools updated to 34.0.3
  • 2023-03-04 Platform tools updated to 34.0.1
  • 2022-10-09 Platform tools updated to 33.0.3
  • 2022-08-10 Alpine updated to 3.16.2
  • 2022-08-10 Alpine updated to 3.16.1
  • 2022-05-24 Alpine updated to 3.16.0
  • 2022-04-06 Alpine updated to 3.15.4
  • 2022-04-06 Alpine updated to 3.15.3
  • 2022-03-23 Alpine updated to 3.15.2
  • 2022-03-17 Alpine updated to 3.15.1
  • 2021-11-24 Alpine updated to 3.15.0
  • 2021-11-13 Alpine updated to 3.14.3
  • 2021-10-02 Glibc updated to 2.34-r0
  • 2021-10-02 Alpine updated to 3.14.2
  • 2021-06-16 Alpine updated to 3.14.0
  • 2021-04-15 Alpine updated to 3.13.5
  • 2021-03-26 Alpine updated to 3.13.3
  • 2021-02-18 Alpine updated to 3.13.2
  • 2021-01-29 Alpine updated to 3.13.1
  • 2021-01-15 Alpine updated to 3.13.0
  • 2020-12-17 Alpine updated to 3.12.3
  • 2020-12-11 Alpine updated to 3.12.2
  • 2020-11-05 Platform tools updated to 30.0.5, glibc to 2.32-r0
  • 2020-10-22 Alpine updated to 3.12.1
  • 2020-10-06 Platform tools updated to 30.0.4
  • 2020-07-01 Alpine updated to 3.12.0, platorm tools updated to 29.0.6
  • 2016-07-02 The image now uses Alpine as the base image, making it way smaller. Furthermore, downloading the platform tools is now done in a more cunning way, further removing almost all dependencies and reducing image size. Only platform-tools are now included.
  • 2016-07-02 Due to internal ADB changes our previous start command no longer works in the latest version. The command has been updated, but if you were specifying it yourself, make sure you're using adb -a -P 5037 server nodaemon. Do NOT use the fork-server argument anymore.
  • 2016-07-02 The .android directory path has been fixed. Thanks to @alexislg2 for spotting it!

Gotchas

  • The container needs extended privileges for USB access
  • The host's /dev/bus/usb must be mounted on the container

Security

The container is preloaded with an RSA key for authentication, so that you won't have to accept a new key on the device every time you run the container (normally the key is generated on-demand by the adb binary). While convenient, it means that your device will be accessible over ADB to others who possess the key. You can supply your own keys by using -v /your/key_folder:/root/.android with docker run.

Updating the platform tools manually

If you feel like the platform tools are out of date and can't wait for a new image, you can update the platform tools with the following command:

update-platform-tools.sh

It's in /usr/local/bin and therefore already in $PATH.

Usage

There are various ways to use this image. Some of the possible usage patterns are listed below. It may sometimes be possible to mix them depending on the case. Also, you don't have to limit yourself to the patterns mentioned here. If you can find another way that works for you, go ahead.

Pattern 1 - Shared network on the same machine (easy)

This usage pattern shares the ADB server container's network with ADB client containers.

Start the server:

docker run -d --privileged -v /dev/bus/usb:/dev/bus/usb --name adbd devicefarmer/adb

Then on the same machine:

docker run --rm -ti --net container:adbd devicefarmer/adb adb devices
docker run --rm -i --net container:adbd ubuntu nc localhost 5037 <<<000chost:devices

Pros:

  • No port redirection required
  • No need to look up IP addresses
  • adb forward works without any tricks (but forwards will only be accessible to the client containers)

Cons:

  • Cannot use bridged (or any other) network on the client container
  • Only works if the server and client containers run on the same machine

Pattern 2 - Host network (easy but feels wrong)

This usage pattern binds the ADB server directly to the host.

Start the server:

docker run -d --privileged --net host -v /dev/bus/usb:/dev/bus/usb --name adbd devicefarmer/adb

Then on the same machine:

docker run --rm -ti --net host devicefarmer/adb adb devices
docker run --rm -i --net host ubuntu nc localhost 5037 <<<000chost:devices

Or on another machine:

docker run --rm -ti sorccu/adb adb -H x.x.x.x -P 5037 devices

Pros:

  • No port redirection required
  • No need to look up IP addresses
  • adb forward works without any tricks (and forwards are visible from other machines)
  • No docker network overhead
  • ADB server visible from other machines

Cons:

  • ADB server visible from other machines unless the startup command is modified
  • Client containers must always use host networking or know the machine's IP address

Pattern 3 - Linked containers on the same machine (can be annoying)

This usage pattern shares the ADB server container's network with ADB client containers.

Start the server:

docker run -d --privileged -v /dev/bus/usb:/dev/bus/usb --name adbd sorccu/adb

Then on the same machine:

docker run --rm -ti --link adbd:adbd sorccu/adb \
  sh -c 'adb -H $ADBD_PORT_5037_TCP_ADDR -P 5037 devices'

Pros:

  • No port redirection required
  • No need to manually look up IP addresses
  • adb forward works without any tricks (but forwards will only be accessible to the client containers over the designated IP)

Cons:

  • Need to always pass the server IP to adb with -H $ADBD_PORT_5037_TCP_ADDR
  • Need to be careful when running the container so that variables get replaced inside the container and not in the calling shell
  • Only works if the server and client containers run on the same machine

Pattern 4 - Remote client

This usage pattern works best when you want to access the ADB server from a remote host.

Start the server:

docker run -d --privileged -v /dev/bus/usb:/dev/bus/usb --name adbd -p 5037:5037 sorccu/adb

Then on the client host:

docker run --rm -ti sorccu/adb adb -H x.x.x.x -P 5037 devices

Where x.x.x.x is the server host machine.

Pros:

  • Scales better (can use any number of hosts/clients)
  • No network limitations

Cons:

  • Need to be aware of IP addresses
  • Higher latency
  • You'll need to make other ports (e.g. from adb forward) accessible yourself

Systemd units

Sample systemd units are provided in the systemd/ folder.

Unit Role Purpose
adb-image.service Support Pulls the image from Docker Hub.
adbd-container.service Support Creates a container for the ADB daemon based on the adb image, but doesn't run it.
adbd.service Primary Runs the prepared ADB daemon container and makes sure it stays alive.

This 3-unit configuration, while slightly complex, offers superior benefits such as incredibly fast start time on failure since everything has already been prepared for adbd.service so that it doesn't have to do any extra work. The adb image will only get pulled once at boot time instead of at every launch (or manually by calling systemctl restart adb-image, which will also restart the other units).

Copy the units to /etc/systemd/system/ on your target machine.

Then, enable adbd.service so that it starts automatically after booting the machine:

systemctl enable adbd

Finally, either reboot or start the service manually:

systemctl start adbd

If you change the units, don't forget to run systemctl daemon-reload or they won't get updated.

Thanks

License

See LICENSE.