User Guide
Everything you need to know about setting up, configuring, and mastering Surveyor for your MSP business.
Installation & Setup
Important: Nmap Required
Surveyor relies on Nmap for network scanning. Please ensure Nmap is installed and added to your system PATH before running scans. Download Nmap for Windows .
- Open Start, search "Environment Variables", and choose "Edit the system environment variables".
- Click "Environment Variables...", then select "Path" under System variables and choose "Edit".
- Click "New" and add the Nmap install folder (for example
C:\Program Files (x86)\Nmap). - Save all dialogs and reopen Surveyor before scanning.
Download
Latest desktop build v1.0.1.
Installer: surveyor-desktop-installer-1.0.1.exe
Portable: surveyor-desktop-1.0.1.exe
System Requirements
- Operating System Windows 10/11
- Memory 4GB RAM minimum (8GB Recommended)
- Dependencies Nmap 7.9+ installed and in PATH
- Permissions Administrator/Root privileges for scanning
Surveyor consists of a desktop application that acts as a control center for your network discovery operations. It uses a local SQLite database to ensure client data remains isolated and secure on your machine.
Core Capabilities
Automated Discovery
Launch ping sweeps (`-sn`) and comprehensive service scans against any subnet. Surveyor automatically maps:
- Active Hosts & IP Addresses
- MAC Addresses & Vendors
- Operating Systems (OS Fingerprinting)
- Open Ports & Running Services
Client Isolation
Designed for MSPs managing multiple tenants. Create distinct profiles for each client to keep network data strictly separated.
- Scoped SQLite Databases
- Per-Client Configuration
- Isolated Scan Histories
- Custom SLA Reporting
Security Insights
Surveyor doesn't just list devices; it analyzes them for potential risks and configuration drifts.
- Unexpected Port Exposure
- Default Service Configurations
- Outdated OS Detection
- New Device Alerts
Documentation
Turn discovery data into deliverables. Export findings for your internal records or client presentations.
- PDF Executive Summaries
- CSV Raw Data Exports
- JSON Integration Format
- Network Topology Maps
Troubleshooting
This is usually due to Nmap missing from the system PATH.
- Open a terminal/command prompt
-
Type
nmap --version - If the command is not found, reinstall Nmap and ensure "Add to PATH" is selected
- Restart Surveyor
Check the following common blockers:
- Firewall Rules: Ensure your local firewall isn't blocking the scanning process
- Network Isolation: If you are on a Guest WiFi or isolated VLAN, discovery will be limited
- Permissions: Some scan types (like OS detection) require root/admin privileges
Surveyor stores data in %USERPROFILE%\.surveyor\surveyor.db.
To backup your data, simply copy this file. To reset the application, delete this file and restart Surveyor.
Need more help?
Check out our GitHub repository for the latest updates, issue tracking, and community support.