Post

Getting Started

Posted
By Thomas Sutter 1 min read

Prerequisites

  • Tested on macOS, Ubuntu, and Debian
  • docker and docker-compose
  • python3 with pip3

Installation

  1. Clone the repository and change to the FirmwareDroid directory
    1
2
3

     git clone --recurse-submodules https://github.com/FirmwareDroid/FirmwareDroid.git
    
 cd FirmwareDroid

  2. Install python packages for the setup:

    1

     pip3 install jinja2

  3. Run the setup script:

    1

     python3 ./setup.py

  4. Build the docker base images (takes some time).

    1
2

     chmod +x ./docker/build_docker_images.sh
 ./docker/build_docker_images.sh

  5. Set correct access rights for the blob storage and start the containers

    1
2

     chown -R $(id -u):$(id -g) ./blob_storage
 docker-compose up

    The first start takes some time because the database will change the mode to a replica-set. Wait until the logscreen stops moving (takes usually 2 to 5 minutes).

  6. Open the browser under https://fmd.localhost. By default, a self-signed certificates is used, and you will encounter a TLS warning.

  7. Log-into the application. Password and username can be found in the .env file within the root directory of the server.

    1
2
3
4
5

     cat .env
 ...
 DJANGO_SUPERUSER_USERNAME=XXXXX-XXXX
 DJANGO_SUPERUSER_PASSWORD=XXXXX-XXXX-XXXX
 ...
  8. After log-in, you can explore the following routes:
Setup, Tutorial
installation getting started
This post is licensed under CC BY 4.0 by the author.