Mac Test Drive Deployment

Mac test drive deployment end-of-life announcement

Starting December 2024, Rapid7 will no longer support the Linux test drive deployment. If you are still using this deployment model, you need to migrate to our Terraform/ECS Fargate-based model. Contact Support for assistance.

This document explains how to deploy InsightCloudSec quickly for evaluation purposes using Docker Compose. If you install InsightCloudSec locally, it should take less than 15 minutes to get up and running.

Product name to be replaced

You may observe that some components, screen captures, or examples use our former product name, DivvyCloud. This doesn't affect the configuration or the product's functionality, and we will notify you as we replace these component names.

If you have questions or issues feel free to reach out to us through the Customer Support Portal.

Minimum System Requirements

When deploying a test drive for InsightCloudSec, we recommend the following minimum specifications:

  • 4 CPU cores
  • 4 GB memory
  • MacOS version 10.15 or newer

Performance Considerations

Note that InsightCloudSec performance will vary wildly depending on the available resources on your laptop while running the test drive deployment. We highly recommend increasing the CPU cores and memory allowed for use with Docker if possible.

Install Docker and Docker-Compose

First, you need to install Docker Community Edition For Mac.

Homebrew

The Homebrew version of Docker may run into issues with writing data to mounted volumes if permissions are not correctly configured. If you have installed the Homebrew version of Docker and have run into any issues, it is recommended that you uninstall it and install the version available from the Docker store.

Starting the InsightCloudSec Environment with Docker Compose

  1. First open a terminal session and create a working folder under your home directory using the following commands:

    bash
    1
    mkdir ~/divvycloud; cd ~/divvycloud

  2. Within the new divvycloud directory, download the environment variables and docker-compose file for running the InsightCloudSec Environment:

    bash
    1
    curl -sO https://s3.amazonaws.com/get.divvycloud.com/compose/prod.env
    2
    curl -s https://s3.amazonaws.com/get.divvycloud.com/compose/docker-compose.db-local.yml -o docker-compose.yml

  3. Update the docker-compose.yml file to only run 1 worker containers instead of 8 (if you run 8 workers, it'll most likely overload your laptop) and update the database configs to work correctly on MacOS:

    bash
    1
    sed -i'.original' -e 's/scale:\ 8/scale:\ 1/g' docker-compose.yml
    2
    sed -i "" -e 's/.*\/var\/lib\/mysql.*/&\n    command:\n     - --lower-case-table-names=1/' docker-compose.yml

  4. Now you are ready to start InsightCloudSec via Docker. Run the command below; the -d flag will run the containers in the background, freeing up your terminal to attach to a container at will (this command can take a while to finish executing):

    bash
    1
    docker-compose up -d

  5. Verify that all the containers are up and running: docker-compose ps

Logging into InsightCloudSec

After InsightCloudSec has completed its launch, you can connect via browser using port 8001, e.g., http://localhost:8001. It may take 10-15 minutes for all of the database tables to be built for the first time, so you may not be able to access the website until this has been completed.

The first page you see is an administrator account creation page. On the page, you enter your name and email address and create a userid and password. Your userid can be any alphanumeric. Your password must be at least 12 characters in length.

Next, you login with the administrator account credentials you just created.

Stop InsightCloudSec with Docker Compose

When your evaluation is over (we hope you enjoyed it!) and you’re ready to stop, use:

bash
1
docker-compose down

Using a Proxy Server

If you wish to use a proxy server for your Test Drive, you will need to add your proxy information to your:

  1. System’s environment variables before your installation
  2. InsightCloudSec environment variables after your installation