diff --git a/agent/README.md b/agent/README.md index f54feaa..bc0ac52 100644 --- a/agent/README.md +++ b/agent/README.md @@ -1,72 +1,5 @@ # paradrop-agent -#### Table of Contents - -1. [Overview](#overview) - - [Example JSON Output](#example-json-output) -2. [Install](#install) -3. [Getting Started Vagrant](#getting-started-vagrant) -4. [Command-Line Arguments](#command-line-arguments) -5. [Configuration](#configuration) - -## Overview - -Lightweight configurable agent that collects system-wide data used for paradrop processing. - -Resources gathered if applicable: - -- Asset Type -- Auditd Rules -- Chassis Type -- Cloud / Container Detection -- CPU Count -- CPU Stats -- CPU Vulnerabilities -- ClamAV Definitions -- Crontabs -- Disk Stats -- DMesg Errors -- Docker Containers -- Docker Images -- Docker Stats -- Domain Name -- EC2 Instance Metadata -- Environment -- Expired SSL Certs -- Failed Logins -- Ruby Gems -- Hostname -- IP Address -- IPTables Rules -- IP Routes -- Kernel Version -- Load Averages -- Loaded Kernel Modules -- Memory Stats -- Network Interface Stats -- NTP Servers -- NTP Running -- RPM / Deb Packages -- Python Pip Packages -- Public -- Snap Packages -- Sysctl Kernel Parameters -- Systemd Failed Services -- Systemd Timers -- Processes -- OpenSCAP XCCDF Scan -- OS Platform -- OS Family -- OS Version -- TCP 4/6 Listening Open Ports -- Timezone -- Trivy Scan -- Uptime -- Users -- Users Logged In -- Virtualization -- Virtualization System - ### Example JSON Output ```json @@ -326,47 +259,12 @@ Resources gathered if applicable: } ``` -## Install - -Install the statically linked Linux binary: - -```sh -curl -OL "https://github.com/MetroStar/paradrop/releases/download/0.10/paradrop-agent" && chmod -f 0755 ./paradrop-agent -``` - -Install DEB file: - -```sh -curl -LO $(curl -s https://api.github.com/repos/MetroStar/paradrop/releases/latest | grep browser_download_url | grep deb | cut -d '"' -f 4) - -dpkg -i ./paradrop-agent*.deb -``` - -Install RPM file: - -```sh -curl -LO $(curl -s https://api.github.com/repos/MetroStar/paradrop/releases/latest | grep browser_download_url | grep rpm | cut -d '"' -f 4) - -rpm -i ./paradrop-agent*.rpm -``` - ### Development -- Go 1.15>= +- Go >=1.22 - Make - Docker (Optional) -Compile from git: - -```sh -git clone https://github.com/MetroStar/paradrop.git -cd paradrop -mkdir -p "$GOPATH"/src/github.com/MetroStar -ln -s "$PWD" "$GOPATH"/src/github.com/MatroStar/ -cd "$GOPATH"/src/github.com/MatroStar/ -make -``` - To build the binary with Go run the following command: ```sh @@ -385,14 +283,6 @@ To build the RPM and Deb packages with Docker run the following command: make VER=0.10 pkgs ``` -## Getting Started Vagrant - -```sh -git clone https://github.com/MetroStar/paradrop.git - -vagrant up -``` - ## Command-Line Arguments No flags / arguments will do a one-time run and produce a JSON file in the current path of the binary diff --git a/docs/README.md b/docs/README.md deleted file mode 100755 index aaba2fa..0000000 --- a/docs/README.md +++ /dev/null @@ -1,41 +0,0 @@ -# Website - -This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. - -### Installation - -``` -$ yarn -``` - -### Local Development - -``` -$ yarn start -``` - -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. - -### Build - -``` -$ yarn build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -### Deployment - -Using SSH: - -``` -$ USE_SSH=true yarn deploy -``` - -Not using SSH: - -``` -$ GIT_USER= yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.