monkey/build_scripts
Mike Salvatore f54b759d92
Merge pull request #1459 from guardicore/extract-deployment-field
Extract deployment field from server config
2021-09-14 12:24:46 -04:00
..
appimage Build: Remove deployment.json files 2021-09-14 12:22:03 -04:00
docker Build: Remove deployment.json files 2021-09-14 12:22:03 -04:00
README.md Build: Move final build artifact to dist/ directory 2021-07-28 07:53:33 -04:00
build_appimage.sh Build: Add build_{appimage,docker}.sh wrapper scripts 2021-07-28 07:00:18 -04:00
build_docker.sh Build: Add build_{appimage,docker}.sh wrapper scripts 2021-07-28 07:00:18 -04:00
build_package.sh Build: Remove unused install_common_build_prereqs() 2021-09-14 12:09:13 -04:00
common.sh Build: Remove duplicate code from appimage build script 2021-07-27 15:25:50 -04:00

README.md

Infection Monkey Linux Package Builder

About

This directory contains the necessary artifacts for building an Infection Monkey packages for Linux.

AppImage

Building an AppImage

  1. Create a clean VM or LXC (not docker!) based on Ubuntu 18.04.
  2. Copy the build_scipts/ directory to $HOME/ in the VM.
  3. On the VM, cd $HOME/build_scripts
  4. Run sudo -v.
  5. Execute ./build_appimage.sh. This will pull all necessary dependencies and build the AppImage.

NOTE: This script is intended to be run from a clean VM. You can also manually remove build artifacts by running appimage/clean.sh

Running the AppImage

The build script will produce an AppImage executable named ./dist/Infection_Monkey-x86_64.AppImage. Simply execute this file and you're off to the races.

A new directory, $HOME/.monkey_island will be created to store runtime artifacts.

Docker

Building a Docker image

  1. Create a clean Ubuntu 18.04 VM (not WSL).
  2. Copy the build_scipts/ directory to $HOME/ in the VM.
  3. On the VM, cd $HOME/build_scripts
  4. Run sudo -v.
  5. Execute ./build_docker.sh --package docker. This will pull all necessary dependencies and build the Docker image.

NOTE: This script is intended to be run from a clean VM. You can also manually remove build artifacts by running docker/clean.sh

Running the Docker Image

The build script will produce a .tgz file in ./dist/. See docker/DOCKER_README.md for instructions on running the docker image.