Zoneweaver Documentation

React-based web frontend for Zoneweaver zone hypervisor management. Provides user management, organization control, and integration with Zoneweaver API for managing Bhyve virtual machines on OmniOS/illumos.

Get started now View API Reference View on GitHub

Getting started

Zoneweaver is the web frontend component of the Zoneweaver zone management system. It provides user authentication, organization management, and a comprehensive web interface for managing Bhyve virtual machines through the Zoneweaver API.

Key Features

User Management: Complete user authentication and authorization system
Multi-Organization Support: Organization-based access control and management
Server Management: Configure and manage multiple Zoneweaver API connections
Web Interface: Modern React-based dashboard for zone management
API Integration: RESTful API for user/organization management and backend integration
Responsive Design: Mobile-friendly interface for on-the-go management

Architecture

graph TD
    A[Web Browser] -- HTTPS --> B[Zoneweaver Frontend];
    B -- User Auth API --> C[Frontend Node.js API];
    B -- Zone Management --> D[Zoneweaver API on OmniOS Host];
    D -- Manages --> E[Bhyve Zones / Virtual Machines];
    C -- Stores --> F[SQLite Database];

Quick start

Installation: Install Zoneweaver frontend via package or build from source
Configuration: Configure settings in /etc/zoneweaver/config.yaml
Setup: Create initial organization and admin user
Backend Connection: Configure Zoneweaver API server connections
Access: Open web interface and start managing zones

Documentation

The Zoneweaver frontend provides comprehensive documentation:

API Reference - Frontend API for user/organization management
Getting Started Guide - Step-by-step setup instructions
Installation Guide - Installation and deployment
User Guide - Web interface usage and features
Backend Integration - Connecting to Zoneweaver API API

About the project

License

Zoneweaver is distributed by an 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 Zoneweaver!

Code of Conduct

Zoneweaver is committed to fostering a welcoming community.

View our Code of Conduct on our GitHub repository.