This documentation describes the Server currently in development.
server · stable
Shumoku Server overview
Bring topologies, monitoring data, and dashboards together in a self-hosted environment.
Shumoku Server is a self-hosted web application that combines network topology diagrams with observations from monitoring systems. A topology can be composed from multiple data sources and display status or utilization in the same interface.
Common uses
- Create a topology from YAML or a Manual source
- Collect inventory, metrics, and alerts through plugins
- Arrange topologies and status widgets on dashboards
- Issue read-only sharing links
- Automate composition, synchronization, rendering, and sharing through the HTTP API
The Server does not redefine input formats or plugin-specific fields in prose. The YAML reference, Server API, and plugin reference are generated from their code contracts.
After installation
- Install the Server and sign in as an administrator.
- Add a data source.
- Create a topology and connect the sources it needs.
- Optionally create a dashboard and configure sharing.