Skip to content

log4jacob/scanopy

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2,011 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Scanopy

Scanopy Logo

Clean network diagrams. One-time setup, zero upkeep.

Scanopy scans your network, identifies hosts and services, and generates an interactive visualization showing how everything connects, letting you easily create and maintain network documentation.

Docker Pulls Github Stars
GitHub release License
Daemon image size Server image size
Daemon Server UI
Discord Translations

💡 Prefer not to self-host? Get a free trial of Scanopy Cloud

Example Visualization

✨ Key Features

  • Automatic Discovery: Scans networks to identify hosts, services, and their relationships
  • 200+ Service Definitions: Auto-detects databases, web servers, containers, network infrastructure, monitoring tools, and enterprise applications
  • Interactive Topology: Generates visual network diagrams with extensive customization options
  • Distributed Scanning: Deploy daemons across network segments to map complex topologies
  • Docker Integration: Discovers containerized services automatically
  • Organization Management: Multi-user support with role-based permissions
  • Scheduled Discovery: Automated scanning to keep documentation current

🎯 Perfect For

  • Home Lab Enthusiasts: Document your ever-growing infrastructure
  • IT Professionals: Maintain accurate network inventory without manual spreadsheets
  • System Administrators: Visualize complex multi-VLAN environments
  • DevOps Teams: Map containerized services and their dependencies
  • MSPs: Manage multiple client networks with your team

📋 Licensing

Self-hosted (AGPL-3.0): Free for all use. Requires source disclosure for network services and copyleft compliance.
Self-hosted (Commercial license): For those who cannot comply with AGPL-3.0 terms. Contact licensing@scanopy.net
Hosted Solution: Scanopy Cloud subscription for zero infrastructure management

🚀 Quick Start for Self Hosting

Docker Compose

curl -O https://raw.githubusercontent.com/scanopy/scanopy/refs/heads/main/docker-compose.yml
docker compose up -d

Proxmox

Use this helper script to create a Scanopy LXC.

Unraid

Available as an Unraid community app.

💡 Prefer not to self-host? Get a free trial of Scanopy Cloud


Access the UI at http://<your-server-ip>:60072, create your account, and wait for the first discovery to complete.

For detailed setup options and configuration, see the Installation Guide.

📚 Documentation + API

scanopy.net/docs

🖼️ Examples

scanopy.net/showcase

🤝 Contributing

We welcome contributions! See our contributing guide for details.

Great first contributions:

💬 Community & Support


Translations powered by Weblate

Built with ❤️ in NYC

About

Network documentation that updates itself

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Rust 67.5%
  • Svelte 21.8%
  • TypeScript 6.4%
  • PLpgSQL 2.3%
  • HTML 0.4%
  • Mermaid 0.4%
  • Other 1.2%