Getting Started

Welcome to Virgo documentation. This guide will help you get started with installing and configuring your VPS management panel.

Requirements

  • Docker & Docker Compose
  • Proxmox VE 7.0+ (for virtualization)
  • Domain name (recommended)
  • SSL certificate (recommended)

Quick Start

# Clone the repository
git clone https://github.com/virgo-panel/virgo.git
cd virgo

# Copy environment file
cp .env.example .env

# Start services
docker compose up -d

Installation

Docker Installation

# Install Docker
curl -fsSL https://get.docker.com | sh

# Start Docker
sudo systemctl enable docker
sudo systemctl start docker

Download & Configure

git clone https://github.com/virgo-panel/virgo.git
cd virgo
cp .env.example .env
nano .env  # Edit configuration

Configuration

Environment Variables

VariableDescriptionDefault
DB_HOSTDatabase hostpostgres
DB_PORTDatabase port5432
JWT_SECRETJWT signing secret-
LICENSE_KEYYour license key-

PVE Setup

Create API Token

In Proxmox VE, go to Datacenter → Permissions → API Tokens:

  1. Click "Add"
  2. Select user (e.g., root@pam)
  3. Enter Token ID (e.g., virgo)
  4. Uncheck "Privilege Separation"
  5. Save the token

API Reference

Authentication

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://your-panel.com/api/v1/instances

Endpoints

GET/api/v1/instances

List all instances

POST/api/v1/instances

Create new instance

DELETE/api/v1/instances/:id

Delete instance