From 62cdfa1b59862b4f9e400192ab2c316e77afc8f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Donncha=20=C3=93=20Cearbhaill?= Date: Wed, 23 Oct 2024 13:19:34 +0200 Subject: [PATCH] Add info to docs on using docker image --- docs/docker.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/docker.md b/docs/docker.md index ca98185..be8631c 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -2,7 +2,22 @@ Using Docker simplifies having all the required dependencies and tools (includin Install Docker following the [official documentation](https://docs.docker.com/get-docker/). -Once installed, you can clone MVT's repository and build its Docker image: +Once Docker is installed, you can run MVT by downloading a prebuilt MVT Docker image, or by building a Docker image yourself from the MVT source repo. + +### Using the prebuilt Docker image + +```bash +docker pull ghcr.io/mvt-project/mvt +``` + +You can then run the Docker container with: + +``` +docker run -it ghcr.io/mvt-project/mvt +``` + + +### Build and run Docker image from source ```bash git clone https://github.com/mvt-project/mvt.git @@ -18,6 +33,9 @@ docker run -it mvt If a prompt is spawned successfully, you can close it with `exit`. + +## Docker usage with Android devices + If you wish to use MVT to test an Android device you will need to enable the container's access to the host's USB devices. You can do so by enabling the `--privileged` flag and mounting the USB bus device as a volume: ```bash