Initial commit

This commit is contained in:
2025-08-30 18:55:20 -04:00
commit eb00a5472f
19 changed files with 4263 additions and 0 deletions

95
QUICKSTART.md Normal file
View File

@@ -0,0 +1,95 @@
# Quick Start Guide
## Prerequisites
1. **Install .NET 8.0 SDK**
- Download from: https://dotnet.microsoft.com/download
- Verify installation: `dotnet --version`
2. **Install QEMU**
- **Windows**: Download from https://qemu.weilnetz.de/
- **Linux**: `sudo apt install qemu-system-x86` (Ubuntu/Debian)
- **macOS**: `brew install qemu`
3. **For KVM acceleration (Linux only)**:
```bash
sudo apt install qemu-kvm libvirt-daemon-system libvirt-clients bridge-utils
sudo usermod -aG kvm $USER
sudo usermod -aG libvirt $USER
```
## Quick Start
1. **Clone and build**:
```bash
git clone <repository-url>
cd skystack
dotnet build
```
2. **Run the application**:
```bash
dotnet run --project QemuVmManager.Console
```
3. **Create your first VM**:
```
qemu-vm> create my-first-vm
Enter VM name: my-first-vm
Description (optional): My first VM
CPU cores (2): 2
CPU model (qemu64): qemu64
Memory size in MB (2048): 2048
Disk path: /path/to/your/disk.qcow2
Disk size in GB (10): 10
Disk format (qcow2): qcow2
Disk interface (virtio): virtio
Network bridge (virbr0): virbr0
Display type (gtk): gtk
VGA type (virtio): virtio
```
4. **Start the VM**:
```
qemu-vm> start my-first-vm
```
5. **Check status**:
```
qemu-vm> status my-first-vm
```
## Common Commands
- `list` - Show all VMs
- `start <name>` - Start a VM
- `stop <name>` - Stop a VM
- `pause <name>` - Pause a VM
- `resume <name>` - Resume a VM
- `delete <name>` - Delete a VM
- `help` - Show all commands
## Troubleshooting
### QEMU not found
- Ensure QEMU is installed and in your PATH
- Windows: Add QEMU installation directory to PATH
### Permission denied (Linux)
- Add your user to kvm and libvirt groups
- Restart your session after adding groups
### Network bridge not found
- Create the bridge: `sudo virsh net-start default`
- Or use user networking: change bridge to "user" in VM config
### Build issues
- Ensure .NET 8.0 SDK is installed
- Run `dotnet --version` to verify
- Try `dotnet restore` before building
## Next Steps
1. Read the full [README.md](README.md) for detailed documentation
2. Check the [examples/](examples/) directory for sample configurations
3. Explore advanced features like SPICE remote desktop and shared folders