Shumoku Docs

Search documentation

Server · next

Loading search…

日本語

This documentation describes the Server currently in development.

development · 73ebc72ba0bc

Shumoku Server 0.1.6-beta.4

Version-matched guides and reference generated from the Server release.

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

  1. Install the Server and sign in as an administrator.
  2. Add a data source.
  3. Create a topology and connect the sources it needs.
  4. Optionally create a dashboard and configure sharing.

Documentation

Server API
OpenAPI · 109 Plugins
Descriptors · 9

Guides

Add a data sourceSelect a plugin, validate its connection, and make it available to topologies. Authentication, APIs, and shared accessUnderstand access boundaries for management APIs, sharing, webhooks, and WebSocket. Create a topologyCreate a topology in Shumoku Server and prepare it for data sources. Create and share a dashboardCombine multiple topologies and monitoring widgets into one operational view. Install and operate the ServerDeploy safely with Docker and configure TLS, updates, and backups.