Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,40 @@ 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:

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
^^^^^^^^^^^

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

brew install gettext

For the Android deploy to develop pipeline, `jadx <https://github.com/skylot/jadx>` and `Java <https://openjdk.org/index.html>`_ 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
^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -326,6 +374,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
^^^^^^^^

Expand Down