https://github.com/scanopy/scanopy
Clean network diagrams. One-time setup, zero upkeep.
https://github.com/scanopy/scanopy
documentation documentation-generator documentation-tools homelab network-analysis network-diagram network-diagrams network-docs network-documentation network-mapper network-mapping-tool network-visualization network-visualizer networking self-hosted visualization
Last synced: about 1 month ago
JSON representation
Clean network diagrams. One-time setup, zero upkeep.
- Host: GitHub
- URL: https://github.com/scanopy/scanopy
- Owner: scanopy
- License: agpl-3.0
- Created: 2025-09-29T18:37:20.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2026-01-16T06:26:18.000Z (about 2 months ago)
- Last Synced: 2026-01-17T00:43:32.004Z (about 2 months ago)
- Topics: documentation, documentation-generator, documentation-tools, homelab, network-analysis, network-diagram, network-diagrams, network-docs, network-documentation, network-mapper, network-mapping-tool, network-visualization, network-visualizer, networking, self-hosted, visualization
- Language: Rust
- Homepage: https://scanopy.net
- Size: 49.5 MB
- Stars: 3,757
- Watchers: 18
- Forks: 179
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- Funding: .github/funding.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-github-repos - scanopy/scanopy - Clean network diagrams. One-time setup, zero upkeep. (Rust)
- definitive-opensource - Scanopy - time setup, zero upkeep. | `SelfHost` `Web (Cloud)` `Cross` | **4.1k** | (Table of Contents / Network)
README
# Scanopy
**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.
 
 
 
  
[](https://discord.gg/b7ffQr8AcZ)
> 💡 **Prefer not to self-host?** [Get a free trial](https://scanopy.net) of Scanopy Cloud
## ✨ 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](LICENSE.md)):** Free for all use. Requires source disclosure for network services and copyleft compliance.
**Self-hosted ([Commercial license](COMMERCIAL-LICENSE.md)):** For those who cannot comply with AGPL-3.0 terms. Contact licensing@scanopy.net
**Hosted Solution:** **[Scanopy Cloud](https://scanopy.net)** subscription for zero infrastructure management
## 🚀 Quick Start for Self Hosting
**Docker Compose**
```bash
curl -O https://raw.githubusercontent.com/scanopy/scanopy/refs/heads/main/docker-compose.yml
docker compose up -d
```
**Proxmox**
Use this [helper script](https://community-scripts.github.io/ProxmoxVE/scripts?id=scanopy) to create a Scanopy LXC.
**Unraid**
Available as an Unraid community app.
> 💡 **Prefer not to self-host?** [Get a free trial](https://scanopy.net) of Scanopy Cloud
---
Access the UI at `http://:60072`, create your account, and wait for the first discovery to complete.
For detailed setup options and configuration, see the [Installation Guide](https://scanopy.net/docs/server-installation).
## 📚 Documentation + API
**[scanopy.net/docs](https://scanopy.net/docs)**
## 🖼️ Examples
**[scanopy.net/showcase](https://scanopy.net/showcase)**
## 🤝 Contributing
We welcome contributions! See our [contributing guide](contributing.md) for details.
Great first contribution: [adding service definitions](contributing.md#adding-service-definitions)
## 💬 Community & Support
- **Discord**: [Join our Discord](https://discord.gg/b7ffQr8AcZ) for help and discussions
- **Issues**: [Report bugs or request features](https://github.com/scanopy/scanopy/issues/new)
- **Discussions**: [GitHub Discussions](https://github.com/scanopy/scanopy/discussions)
---
**Built with ❤️ in NYC**