Skip to content
This repository has been archived by the owner on Sep 28, 2023. It is now read-only.

Latest commit

 

History

History
executable file
·
36 lines (27 loc) · 2.05 KB

quickstart.md

File metadata and controls

executable file
·
36 lines (27 loc) · 2.05 KB

Quick Start Guide

Setup on AWS, GCP, or OpenStack

Security Monkey can run on an Amazon EC2 (AWS) instance, Google Cloud Platform (GCP) instance (Google Cloud Platform), or OpenStack (public or private cloud) instance. The only real difference in the installation is the IAM configuration and the bringup of the Virtual Machine that runs Security Monkey.

GitHub Organization Monitoring

For monitoring GitHub, please read the GitHub monitoring documentation here.

Running Security Monkey in Production

The Quickstart guide is great for learning about Security Monkey and trying it, but it is not adequate for production deployments. If you follow the steps in Quickstart Security Monkey will not automatically scan your environment and won't scale for large accounts. For production deployment guidance please read Autostarting and Tuning the Watchers/Prioritizing before beginning installation.

Installation Instructions:

  1. Follow the proper IAM and permissions instructions for your platform: AWS, GCP, OpenStack, GitHub
  2. Launch a server
  3. Create a database instance
  4. Install Security Monkey on your server instance
  5. Populate your Security Monkey with Accounts
  6. Create an SSL Certificate
  7. Setup Nginx
  8. Login to Security Monkey & load data
  9. Hardening Security Monkey for Production (Autostarting)

User Guide

See the User Guide for a walkthrough of Security Monkey's features.

Contribute

It's easy to extend Security Monkey with new rules or new technologies. Please read our Contributing Documentation for additional details.