Developer Documentation
Hostinvo Documentation
Everything you need to deploy, configure, and operate the Hostinvo hosting automation platform.
Getting Started
Introduction
What Hostinvo is, how the platform is structured, and how to navigate this documentation.
Quick Start
Get a development environment running in under 10 minutes with Docker Compose.
Environment Variables
Complete reference for all required and optional environment variables for backend and frontend.
First Provider Setup
Create a provider account, configure your company, connect a server, and publish your first product.
Onboarding Wizard
Step-by-step walkthrough of the 4-step provider onboarding flow built into the platform.
Platform Modules
Tenant Architecture
How multi-tenancy works — shared-schema isolation, tenant_id scoping, and the global TenantScope.
Billing & Invoicing
Invoice lifecycle, recurring billing cycles, payment processing, dunning, and the transaction ledger.
Provisioning Engine
Queue-driven server provisioning with cPanel/WHM and Plesk drivers, retries, and lifecycle events.
Domain Management
Domain registration, renewal, contact management, and registrar integration.
Support & Ticketing
Client ticket creation, staff assignment, reply threading, and ticket status automation.
Authentication & Roles
Sanctum-based auth, tenant-scoped sessions, role definitions, and permission policies.
Product Catalog
Product groups, pricing cycles, service types, and catalog management APIs.
Operations & Deployment
Docker Setup
Development, staging, and production Docker Compose configurations with all services.
Production Deployment
Step-by-step production deployment runbook: migrations, cache warmup, queue startup.
Staging Environment
Configure a staging environment that mirrors production for pre-launch validation.
Backup & Recovery
PostgreSQL dump backups, Redis RDB snapshots, storage archives, and restore procedures.
Monitoring & Health Checks
Health endpoints, Prometheus metrics, alert thresholds, and webhook alert delivery.
CI/CD Overview
GitHub Actions pipeline structure, environment gates, and deployment automation.
Performance Testing
k6 load test scenarios, concurrency baselines, and performance benchmarks.
Developer Reference
API Overview
RESTful API structure, authentication, versioning (v1), and response format conventions.
Webhooks
Incoming webhook processing for Stripe and PayPal — signature verification and event handling.
Localization & RTL
EN/AR locale routing, translation file structure, RTL layout behavior, and adding new locales.
Development Environment
Local development setup with Hot Module Replacement, queue worker, and scheduler.
Security & Compliance
Security Hardening
XSS protections, CSRF, rate limiting, webhook allowlisting, and tenant isolation audit.
Troubleshooting
Common issues, diagnostic commands, log locations, and queue failure recovery.
FAQ
Frequently asked questions about the platform, licensing, migration, and operations.
Ready to get started?
Start the provider onboarding wizard and have your platform live in minutes.
Start 7-day trial