Welcome to Infinibay Documentation

Infinibay is an open-source Virtual Desktop Infrastructure (VDI) solution built specifically for small and medium-sized businesses. This documentation provides guides for installation, development, and architecture.

What is Infinibay?

Infinibay simplifies VDI deployment by focusing on what SMBs actually need:

• Automated Installer: Handles dependencies and configuration
• Web-based Management: Create and manage VMs through a web interface
• No Enterprise Bloat: Features SMBs need without the complexity of VMware or Proxmox
• Open Source: AGPL v3 license, runs on your infrastructure

Documentation Sections

Getting Started

New to Infinibay? Start here to install and configure the system.

• Installation Guide - Install Infinibay using the installer
• Quick Start - Create your first VM

Backend Documentation

Backend architecture, database design, and GraphQL API:

• Architecture Overview - Backend tech stack and design patterns
• Database Schema - Prisma models and relationships
• GraphQL API - Complete API reference
• Authentication - Auth system and security
• VM Management - Virtual machine operations
• Firewall - Network filtering system

Frontend Documentation

Frontend architecture and components:

• Architecture Overview - Frontend tech stack and patterns
• Styling System - Tailwind CSS and design tokens

Infiniservice Documentation

Guest agent that runs inside VMs:

• Architecture - How infiniservice works

Quick Links

Most Commonly Accessed Pages

• Installation Guide - Get Infinibay running
• Backend Architecture - Understand the backend
• Frontend Architecture - Understand the frontend
• GraphQL API Reference - Complete API documentation
• Firewall Management - Network filtering system

Technology Stack

Backend:

• Node.js 18+ with TypeScript
• Apollo Server 3 (GraphQL)
• Prisma 6 (PostgreSQL ORM)
• Libvirt (via native Rust bindings)
• Redis (caching)

Frontend:

• Next.js 14 (App Router)
• React 18
• TypeScript
• Apollo Client 3
• Tailwind CSS

Infrastructure:

• Libvirt/KVM (virtualization)
• PostgreSQL (database)
• Redis (cache)
• Ubuntu Server (host OS)

Philosophy

1. Simplicity Over Features: Focus on what SMBs need, not enterprise feature parity.
2. Wizards for Complex Operations: Step-by-step guides for VM creation, network configuration, etc.
3. Smart Defaults: The system can suggest VM configurations based on the OS and use case.

Learn more about our philosophy in the project README.

Contributing

Infinibay is open source and welcomes contributions! Here's how you can help:

• Report Bugs: Open an issue on GitHub
• Suggest Features: Describe the problem you're trying to solve (not the solution!)
• Submit Pull Requests: Follow our contribution guidelines
• Improve Documentation: Help make these docs even better

See the Contributing Guide for details.

Getting Help

• Documentation: You're already here! Use the search feature or browse sections
• GitHub Issues: Report bugs or request features
• Community Support: Join discussions in GitHub issues
• Email: For private inquiries, contact contact@infinibay.net

License

Infinibay is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

This means:

• You can use, modify, and distribute Infinibay freely
• If you modify Infinibay and provide it as a service, you must make your modifications available under AGPL-3.0
• See the LICENSE file in the repository for full details

Ready to get started? Head to the Installation Guide to deploy Infinibay on your infrastructure.