Home

Osprey User Guide

Network Visibility & Engineering Platform

This guide covers everything from first login to advanced administration. Osprey discovers network topology via IGP adjacencies (OSPFv2, OSPFv3, IS-IS, EIGRP) and Layer 2 neighbors (LLDP/CDP), monitors traffic via SNMP, and visualizes everything on an interactive canvas with diagnostic reports, what-if simulation, and time travel — all from a single web UI.

This wiki mirrors the guide built into the product (Help > User Guide in the app), so it always reflects the same content without needing a running instance.

Looking for the installer instead? See the Releases page, or the Osprey homepage.

Contents

1. Getting Started — installation, first login, the hierarchy model
2. Dashboard — the landing-page overview
3. Setting Up Topology Discovery — GRE/SNMP collectors, L2 discovery, BGP monitoring (BMP), EVPN, MPLS
4. The Topology Canvas — navigation, layout, area clouds
5. View Controls — labels, colors, themes, icon packs
6. Device & Link Inspection — detail panels, SPF paths, route explanations
7. Reports — inventory, routing, BGP, diagnostics
8. Tools — search, time travel, what-if simulation, exports
9. Alerts & Incidents — alert rules, notification channels, incident correlation
10. SSH Terminal — browser-based device access
11. Administration — users, SSO/SAML/LDAP, system settings, backup & restore
12. Keyboard Shortcuts
13. Configuration Reference — server config, environment variables, systemd services
14. Troubleshooting