Building images

Available images are all present in the images submodule that can be checked with git as follows inside RF Swift root directory:

git submodule update --init --recursive

When entering the images directory, you can see different files and directory:

• config: where configurations files are stored for specific tools;
• Dockerfiles: Docker files to build images;
• rules: some dev rules files specific to devices;
• run: bash script we want to run;
• scripts: installation scripts.

To build you own images, the important dicterories are scripts and Dockerfiles.

Making a custom image

So let say we want to cook a light images, for an RTL-SDR v4 device only, and just need GQRX tool, we can use the corebuild images reference at the begining of our Docker file:

FROM penthertz/rfswift:corebuild

To make the image be recognized by RF Swift, we need to use also the following labels:

LABEL "org.container.project"="rfswift"
LABEL "org.container.author"="Super author" # optional

After that, you can put all function you want to install, but remember to update packages manager list first:

...
RUN apt-fast update # required before!

RUN ./entrypoint.sh rtlsdrv4_devices_install && \
    ./entrypoint.sh gqrx_soft_install
...

And voilà!

Do not hesitate to finish the Docker file cleaning stuff:

# Cleaning and quitting
WORKDIR /root/
RUN rm -rf /root/thirdparty && \
  rm -rf /root/rules/ && \
  rm -rf /root/config/ && \
  apt-fast clean
RUN DEBIAN_FRONTEND=noninteractive rm -rf /var/lib/apt/lists/*

Making your own installation function

Creating a source file

Installation functions are called by entrypoint.sh script inside RF-Swift/images/scripts directory.

The different installation function are included in some script files:

$ ls
automotive_software.sh  common.sh     entrypoint.sh      lab_software.sh      rf_tools.sh    sast_software.sh    sdr_softwares.sh     terminal_harness.sh
cal_devices.sh          corebuild.sh  gr_oot_modules.sh  reverse_software.sh  sa_devices.sh  sdr_peripherals.sh  telecom_software.sh

If you want to create a new script file, and include it, you need also to include it in entrypoint.sh as follows:

#!/bin/bash

...
source yournewsourcefile.sh

Making functions

To make a function, you will then just need to call it as you whish, but something that could be practical and easy to copy for users such as:

function newsuper_soft_install() {
  // your code here
}

So you can then put any script you want, but do be efficient, we also provide you with some harness functions to make things easier

List of harness functions