Skip to content

Commit 054605c

Browse files
authored
1676 add android inspector install doc (#1775)
* Update installation.rst #1676 * Add instructions to install jadx, Java, and android-inspector Signed-off-by: Jono Yang <[email protected]> * Add Dockerfile modification instructions #1676 Signed-off-by: Jono Yang <[email protected]> --------- Signed-off-by: Jono Yang <[email protected]>
1 parent a00860c commit 054605c

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

docs/installation.rst

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,40 @@ create an **environment file**, and **build the Docker image**::
5555
As the ``docker-compose`` v1 command is officially deprecated by Docker, you will
5656
only find references to the ``docker compose`` v2 command in this documentation.
5757

58+
.. note::
59+
If you intend to run an Android deploy to develop project, ``Java``, ``jadx
60+
v1.5.0`` and ``android-inspector`` must be installed in the Docker image by
61+
adding the following lines to the ``Dockerfile`` and rebuilding the Docker
62+
image:
63+
64+
Add at line 65 after `apt-get` command::
65+
66+
# Install Java and utilities to install jadx
67+
RUN apt-get update \
68+
&& apt-get install -y --no-install-recommends \
69+
openjdk-17-jre-headless \
70+
unzip \
71+
wget
72+
73+
# Download and extract jadx
74+
RUN wget https://github.com/skylot/jadx/releases/download/v1.5.0/jadx-1.5.0.zip \
75+
&& unzip -d /usr jadx-1.5.0.zip
76+
77+
# Remove jadx archive and installed utilities
78+
RUN apt-get remove -y unzip wget \
79+
&& apt-get clean \
80+
&& rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* \
81+
&& rm jadx-1.5.0.zip
82+
83+
Add at end of file::
84+
85+
# Install android-inspector
86+
RUN pip install --no-cache-dir android-inspector
87+
88+
Rebuild the image::
89+
90+
docker compose build
91+
5892
Run the App
5993
^^^^^^^^^^^
6094

@@ -293,6 +327,20 @@ For the :ref:`pipeline_collect_strings_gettext` pipeline, `gettext <https://www.
293327

294328
brew install gettext
295329

330+
For the Android deploy to develop pipeline, `jadx <https://github.com/skylot/jadx>` and `Java <https://openjdk.org/index.html>`_ are needed.
331+
332+
* On **Linux** install it using::
333+
334+
# Ensure that you are in the scancode.io directory
335+
sudo apt-get install openjdk-21-jre # Install Java 21
336+
wget https://github.com/skylot/jadx/releases/download/v1.5.0/jadx-1.5.0.zip # Download jadx v1.5.0
337+
unzip -qd jadx-1.5.0 jadx-1.5.0.zip # Extract jadx-1.5.0.zip
338+
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
339+
340+
* On **MacOS** install it using Homebrew::
341+
342+
brew install jadx
343+
296344
Clone and Configure
297345
^^^^^^^^^^^^^^^^^^^
298346

@@ -326,6 +374,11 @@ Clone and Configure
326374

327375
make envfile
328376

377+
* If you intend to run an Android deploy to develop project, install the pipeline::
378+
379+
source .venv/bin/activate
380+
pip install android-inspector
381+
329382
Database
330383
^^^^^^^^
331384

0 commit comments

Comments
 (0)