Skip to content

Commit

Permalink
Update agent docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marshyski committed May 17, 2024
1 parent 4bbcb16 commit 61e4147
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 152 deletions.
112 changes: 1 addition & 111 deletions agent/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
41 changes: 0 additions & 41 deletions docs/README.md

This file was deleted.

0 comments on commit 61e4147

Please sign in to comment.