History

Mike Salvatore f7cc01811c build: address shellcheck findings in build_appimage.sh		2021-04-04 21:28:04 -04:00
..
README.md	build: run `apt upgrade` in appimage script	2021-04-04 21:08:48 -04:00
build_appimage.sh	build: address shellcheck findings in build_appimage.sh	2021-04-04 21:28:04 -04:00
island_logger_config.json	build: select server and logger config at runtime in appimage	2021-03-31 07:37:49 -04:00
monkey_island_builder.yml	build: remove unnecessary includes from monkey_island_builder.yml	2021-03-31 08:27:41 -04:00
run_appimage.sh	build: create appimage-comaptible server_config.json on start	2021-03-31 08:27:41 -04:00
server_config.json.standard	build: add data_dir to standard server config in appimage build	2021-03-31 08:27:41 -04:00

README.md

Monkey Island AppImage

About

This directory contains the necessary artifacts for building a prototype monkey_island AppImage using appimage-builder.

Building an AppImage

Create a clean VM or LXC (not docker!) based on Ubuntu 18.04.
Copy the deployment_scripts/appimage directory to $HOME/ in the VM.
Run sudo -v.
On the VM, cd $HOME/appimage
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 removing the following files and directories.

$HOME/.monkey_island (optional)
$HOME/monkey-appdir
$HOME/git/monkey
$HOME/appimage/appimage-builder-cache
$HOME/appimage/"Monkey\ Island-*-x86-64.Appimage"

After removing the above files and directories, you can again execute bash build_appimage.sh.

Running the AppImage

The build script will produce an AppImage executible named something like Monkey Island-VERSION-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.