BoxVault Documentation

Node.js and React-based web application for managing Vagrant box repositories. Provides user management, organization control, and comprehensive API for uploading, versioning, and distributing Vagrant boxes.

Get started now View API Reference View on GitHub

Getting started

BoxVault is a comprehensive Vagrant box repository management system that provides both a web interface and RESTful API for managing Vagrant boxes, versions, providers, and architectures within organizations.

Key Features

User Management: Complete user authentication and authorization system with JWT tokens
Multi-Organization Support: Organization-based access control and box management
Box Management: Upload, version, and distribute Vagrant boxes with metadata
Provider Support: Support for multiple providers (VirtualBox, VMware, etc.)
Architecture Support: Multi-architecture box support (x86_64, arm64, etc.)
File Management: Secure file upload/download with range request support
API Integration: Comprehensive RESTful API with Swagger documentation
Responsive Design: Modern React-based interface for box management

Architecture

graph TD
    A[Web Browser] -- HTTPS --> B[BoxVault Frontend];
    B -- User Auth API --> C[BoxVault Node.js API];
    B -- Box Management --> C;
    C -- Stores --> D[Database];
    C -- File Storage --> E[Box Storage Directory];
    F[Vagrant Client] -- API --> C;

Quick start

Installation: Install BoxVault via package or build from source
Configuration: Configure database and storage settings
Setup: Create initial organization and admin user
Upload: Start uploading and managing Vagrant boxes
Access: Use web interface or API to manage your box repository

Documentation

BoxVault provides comprehensive documentation:

API Reference - Complete API documentation with Swagger
Getting Started Guide - Step-by-step setup instructions
Installation Guide - Installation and deployment
User Guide - Web interface usage and features
Authentication Guide - User and API authentication

About the project

License

BoxVault 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 BoxVault!

Code of Conduct

BoxVault is committed to fostering a welcoming community.

View our Code of Conduct on our GitHub repository.