Hyperweaver Server Documentation

Hyperweaver Server is the control-plane server for the Hyperweaver platform. It serves the Hyperweaver UI and provides user management, organization control, and proxying to host agents (the Zoneweaver Agent for Bhyve/OmniOS) for managing virtual machines.

Get started now View API Reference View on GitHub

---

Getting started

Hyperweaver Server is the control-plane component of the Hyperweaver platform. It provides user authentication, organization management, and a web interface (the Hyperweaver UI) for managing virtual machines through host agents.

Key Features

• User Management: Complete user authentication and authorization system
• Multi-Organization Support: Organization-based access control and management
• Agent Management: Configure and manage multiple host-agent connections
• Web Interface: Serves the Hyperweaver UI (a React SPA) for management
• API Integration: RESTful API for user/organization management and agent proxying
• Responsive Design: Mobile-friendly interface for on-the-go management

Architecture

graph TD
    A[Web Browser] -- HTTPS --> B[Hyperweaver Server];
    B -- Serves --> G[Hyperweaver UI];
    B -- User Auth API --> C[Server Node.js API];
    B -- Proxy --> D[Zoneweaver Agent on OmniOS Host];
    D -- Manages --> E[Bhyve Zones / Virtual Machines];
    C -- Stores --> F[SQLite Database];

Quick start

1. Installation: Install Hyperweaver Server via the .deb package or build from source
2. Configuration: Configure settings in /etc/hyperweaver-server/config.yaml
3. Setup: Create initial organization and admin user
4. Agent Connection: Configure host-agent (Zoneweaver Agent) connections
5. Access: Open the web interface and start managing machines

Documentation

• API Reference - Server API for user/organization management
• Getting Started Guide - Step-by-step setup instructions
• Installation Guide - Installation and deployment
• Backend Integration - Connecting to host agents

---

About the project

Hyperweaver Server is © 2025 by the Hyperweaver Project.

License

Hyperweaver Server is distributed under a GPL-3.0 license.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Read more about becoming a contributor in our GitHub repo.

Thank you to the contributors of Hyperweaver Server!

• 
• 
• 
• 

Code of Conduct

Hyperweaver Server is committed to fostering a welcoming community.

View our Code of Conduct on our GitHub repository.