p20319658
/
monkey
forked from p34709852/monkey
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Build: Add README.md for build_package.sh

This commit is contained in:
Mike Salvatore 2021-07-27 15:31:33 -04:00
parent ae1427f6a6
commit 0609bc2063
3 changed files with 45 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
build_scripts/README.md Normal file
View File

@ -0,0 +1,45 @@
# 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.
1. Copy the `build_scipts/` directory to `$HOME/` in the VM.
1. On the VM, `cd $HOME/build_scripts`
1. Run `sudo -v`.
1. Execute `./build_package.sh --package appimage`. 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
`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).
1. Copy the `build_scipts/` directory to `$HOME/` in the VM.
1. On the VM, `cd $HOME/build_scripts`
1. Run `sudo -v`.
1. Execute `./build_package.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
See `docker/DOCKER_README.md` for instructions on running the docker image.

27
build_scripts/appimage/README.md
View File

@ -1,27 +0,0 @@
# Monkey Island AppImage
## About
This directory contains the necessary artifacts for building an Infection
Monkey AppImage
## Building an AppImage
1. Create a clean VM or LXC (not docker!) based on Ubuntu 18.04.
1. Copy the `deployment_scripts/appimage` directory to `$HOME/` in the VM.
1. On the VM, `cd $HOME/appimage`
1. Run `sudo -v`.
1. 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
`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.

20
build_scripts/docker/README.md
View File

@ -1,20 +0,0 @@
# Monkey Island Docker Image
## About
This directory contains the necessary artifacts for building an Infection
Monkey Docker image.
## Building a Docker image
1. Create a clean Ubuntu 18.04 VM (not WSL).
1. Copy the `docker/` directory to `$HOME/` in the VM.
1. On the VM, `cd $HOME/docker`
1. Run `sudo -v`.
1. Execute `./build_docker.sh`. 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 rtifacts by running `docker/clean.sh`
## Running the Docker Image
See `docker/DOCKER_README.md` for instructions on running the docker image.