Home - rapid7/nexpose-client GitHub Wiki

Welcome to the nexpose-client wiki!

Getting started

Get started with the Nexpose gem and Ruby on Windows or Ubuntu.

If you're looking for ready-made scripts or would like to share your own please visit the Nexpose Resources project.

Release Notes

• View the Release Notes Page to see what has changed in the latest Release.
• View the Change Log for a more detailed list of what has changed for each version.

Walk-throughs

Here are walk-throughs of how to use certain features in the gem.

• Using Sites
• Scanning
• Using Reports
• Using Asset Filter Searching and Dynamic Asset Groups
• Using Shared Credentials
• Creating a Scan Template of Recent Vulnerability Checks
• Using Tags
• Using Multi Tenancy
• Using Discovery Connections
• Using Two Factor Authentication
• Trusting the Nexpose web server certificate for TLS connections
• Using/Setting Nexpose-client HTTP Timeouts
• Using Web Credentials in a Site Configuration

Development

This is information about developing the gem itself.

• Design Principles

Conversion Guides

Guides for converting across versions of the gem.

• 0.2.x to 0.5 (Deprecated)
• 0.9.x to 1.0