From e195424a34601e16879f40a84f1e06fb6fcc2929 Mon Sep 17 00:00:00 2001 From: Jono Yang Date: Thu, 24 Jul 2025 12:01:48 -0700 Subject: [PATCH 1/2] Update installation.rst #1676 * Add instructions to install jadx, Java, and android-inspector Signed-off-by: Jono Yang --- docs/installation.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/installation.rst b/docs/installation.rst index e1fb8cc0f0..d4046dc090 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -55,6 +55,12 @@ create an **environment file**, and **build the Docker image**:: As the ``docker-compose`` v1 command is officially deprecated by Docker, you will only find references to the ``docker compose`` v2 command in this documentation. +.. note:: + If you intend to run an Android deploy to develop project, ``Java``, ``jadx + v1.5.0`` and ``android-inspector`` must be installed in the Docker image by + adding the following lines to the ``Dockerfile`` and rebuilding the Docker + image:: + Run the App ^^^^^^^^^^^ @@ -293,6 +299,20 @@ For the :ref:`pipeline_collect_strings_gettext` pipeline, `gettext ` and `Java `_ are needed. + + * On **Linux** install it using:: + + # Ensure that you are in the scancode.io directory + sudo apt-get install openjdk-21-jre # Install Java 21 + wget https://github.com/skylot/jadx/releases/download/v1.5.0/jadx-1.5.0.zip # Download jadx v1.5.0 + unzip -qd jadx-1.5.0 jadx-1.5.0.zip # Extract jadx-1.5.0.zip + export PATH=$PATH:`pwd`/jadx-1.5.0/bin/jadx:`pwd`/jadx-1.5.0/lib # add jadx-1.5.0 binary and libraries to your path + + * On **MacOS** install it using Homebrew:: + + brew install jadx + Clone and Configure ^^^^^^^^^^^^^^^^^^^ @@ -326,6 +346,11 @@ Clone and Configure make envfile + * If you intend to run an Android deploy to develop project, install the pipeline:: + + source .venv/bin/activate + pip install android-inspector + Database ^^^^^^^^ From 366724296c70c9c3b0a1ce27c137bbb226d5e09e Mon Sep 17 00:00:00 2001 From: Jono Yang Date: Thu, 24 Jul 2025 14:31:46 -0700 Subject: [PATCH 2/2] Add Dockerfile modification instructions #1676 Signed-off-by: Jono Yang --- docs/installation.rst | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/installation.rst b/docs/installation.rst index d4046dc090..2f38728beb 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -59,7 +59,35 @@ create an **environment file**, and **build the Docker image**:: If you intend to run an Android deploy to develop project, ``Java``, ``jadx v1.5.0`` and ``android-inspector`` must be installed in the Docker image by adding the following lines to the ``Dockerfile`` and rebuilding the Docker - image:: + image: + + Add at line 65 after `apt-get` command:: + + # Install Java and utilities to install jadx + RUN apt-get update \ + && apt-get install -y --no-install-recommends \ + openjdk-17-jre-headless \ + unzip \ + wget + + # Download and extract jadx + RUN wget https://github.com/skylot/jadx/releases/download/v1.5.0/jadx-1.5.0.zip \ + && unzip -d /usr jadx-1.5.0.zip + + # Remove jadx archive and installed utilities + RUN apt-get remove -y unzip wget \ + && apt-get clean \ + && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* \ + && rm jadx-1.5.0.zip + + Add at end of file:: + + # Install android-inspector + RUN pip install --no-cache-dir android-inspector + + Rebuild the image:: + + docker compose build Run the App ^^^^^^^^^^^