Linux

Supported operating systems

An AppImage is a distribution-agnostic, self-running package that contains an application and everything that it may need to run.

The Infection Monkey AppImage package should run on most modern Linux distros that have FUSE installed, but the ones that we’ve tested are:

  • BlackArch 2020.12.01
  • Kali 2021.2
  • Parrot 4.11
  • Rocky 8
  • openSUSE Leap 15.3
  • Ubuntu Bionic 18.04
  • Ubuntu Focal 20.04
  • Ubuntu Hirsute 21.04

Deployment

  1. Make the AppImage package executable:
    chmod u+x Infection_Monkey_v1.11.0.AppImage
    
  2. Start Monkey Island by running the Infection Monkey AppImage package:
    ./Infection_Monkey_v1.11.0.AppImage
    
  3. Access the Monkey Island web UI by pointing your browser at https://localhost:5000.

Start Monkey Island with user-provided certificate

By default, Infection Monkey comes with a self-signed SSL certificate. In enterprise or other security-sensitive environments, it is recommended that the user provide Infection Monkey with a certificate that has been signed by a private certificate authority.

  1. Run the Infection Monkey AppImage package with the --setup-only flag to populate the $HOME/.monkey_island directory with a default server_config.json file.

    ./Infection_Monkey_v1.11.0.AppImage --setup-only
    
  2. (Optional but recommended) Move your .crt and .key files to $HOME/.monkey_island.

  3. Make sure that your .crt and .key files are readable only by you.

    chmod 600 <PATH_TO_KEY_FILE>
    chmod 600 <PATH_TO_CRT_FILE>
    
  4. Edit $HOME/.monkey_island/server_config.json to configure Monkey Island to use your certificate. Your config should look something like this:

     1{
     2  "data_dir": "~/.monkey_island",
     3  "log_level": "DEBUG",
     4  "environment": {
     5    "server_config": "password",
     6    "deployment": "linux"
     7  },
     8  "mongodb": {
     9    "start_mongodb": true
    10 },
    11  "ssl_certificate": {
    12    "ssl_certificate_file": "<PATH_TO_CRT_FILE>",
    13    "ssl_certificate_key_file": "<PATH_TO_KEY_FILE>"
    14  }
    15}
    
  5. Start Monkey Island by running the Infection Monkey AppImage package:

    ./Infection_Monkey_v1.11.0.AppImage
    
  6. Access the Monkey Island web UI by pointing your browser at https://localhost:5000.

Upgrading

Currently, there’s no “upgrade-in-place” option when a new version is released. To get an updated version, download the updated AppImage package and follow the deployment instructions again.

If you’d like to keep your existing configuration, you can export it to a file using the Export config button and then import it to the new Monkey Island.

Export configuration