Welcome to the Ravel documentation! Learn how to deploy and manage containers as microVMs with Ravel.
- Quickstart Guide - Get up and running in minutes
- Installation - Detailed installation instructions
- Configuration - Configure Ravel for your environment
- Architecture - Understanding Ravel's design
- Features - Complete feature reference
- Volumes - Persistent storage
- Health Checks - Monitor machine health
- Private Networks - Encrypted Wireguard networking
- Secrets Management - Secure configuration
- Machine Configuration - Resource management
- API Reference - Complete HTTP API documentation
- Namespaces & Fleets
- Machines & Lifecycle
- Disks & Storage
- Secrets & Security
- Databases - PostgreSQL setup
- Development - Local dev environment with Docker Compose
- Production Deployment - Best practices for production
Browse the examples directory for configuration samples:
- hello-world.json - Basic machine
- volumes-example.json - Persistent storage
- healthcheck-example.json - Health monitoring
- private-network.json - Encrypted networking
- Containerd - Image management details
- Runtime Setup - Runtime configuration
- GitHub: github.com/alexisbouchez/ravel
- Discord: Join our Discord
- Issues: Report bugs