# mortal2424/proxmox-billing-pub architecture

> Architecture diagram of the GitHub repository mortal2424/proxmox-billing-pub, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mortal2424/proxmox-billing-pub
- Repository: https://github.com/mortal2424/proxmox-billing-pub

## Overview

Proxmox Billing is a web panel for provisioning virtual machines and containers, charging users for resources, and monitoring Proxmox infrastructure. The main user journey is to choose a tariff, order a VM or container, then manage it and view usage; administrators configure clusters and nodes, while scheduled jobs handle billing and metric collection. The README documents support tickets and email/Telegram notifications as additional capabilities. Some subsystem links rely on README descriptions or SOURCE INDEX references; unsampled implementation details are not inferred.

Main entry points: [`includes/db.php`](https://github.com/mortal2424/proxmox-billing-pub/blob/main/includes/db.php) (Application database), [`includes/proxmox_functions.php`](https://github.com/mortal2424/proxmox-billing-pub/blob/main/includes/proxmox_functions.php) (Proxmox operations), [`admin/index.php`](https://github.com/mortal2424/proxmox-billing-pub/blob/main/admin/index.php) (Admin console), [`api/collect_vm_metrics.php`](https://github.com/mortal2424/proxmox-billing-pub/blob/main/api/collect_vm_metrics.php) (Metric collection)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_accounts["Accounts and portal"]
  node_public_catalog["Tariff catalog<br/>[index.php]"]
  node_registration["Registration<br/>[register.php]"]
  node_user_portal["User VM portal<br/>[my_vms.php]"]
  node_authentication["Session auth<br/>[auth.php]"]
end

subgraph group_provisioning["Proxmox provisioning"]
  node_admin_portal["Admin console<br/>[index.php]"]
  node_cluster_node_admin["Cluster and node setup<br/>[add_cluster.php]"]
  node_vm_ordering["VM ordering<br/>[order_vm.php]"]
  node_proxmox_api["Proxmox operations"]
end

subgraph group_billing_ops["Billing and monitoring"]
  node_billing["Resource billing<br/>[cron_charge.php]"]
  node_metrics_collection["Metric collection"]
  node_metrics_api["Metrics endpoints<br/>[get_vm_metrics.php]"]
  node_node_monitoring["Node monitoring<br/>[monitoring.php]"]
end

subgraph group_support_backup["Support and backups"]
  node_support_tickets["Support tickets<br/>[support.php]"]
  node_notifications["Email and Telegram alerts"]
  node_telegram_bot["Telegram bot<br/>[telegram_bot.php]"]
  node_backup_jobs["Backup operations"]
end

node_visitor(("Visitor"))
node_user(("Customer"))
node_proxmox_service["Proxmox cluster"]
node_database[("Application database<br/>[db.php]")]

node_visitor -->|"browses"| node_public_catalog
node_visitor -->|"registers"| node_registration
node_user -.->|"manages VMs"| node_user_portal
node_user -->|"orders resources"| node_vm_ordering
node_user_portal -->|"checks session"| node_authentication
node_vm_ordering -->|"invokes provisioning"| node_proxmox_api
node_proxmox_api -->|"controls VMs"| node_proxmox_service
node_cluster_node_admin -->|"configures infrastructure"| node_proxmox_service
node_admin_portal -->|"checks admin role"| node_authentication
node_admin_portal -->|"reads dashboard data"| node_database
node_billing -->|"charges accounts"| node_database
node_metrics_collection -->|"queries VM data"| node_proxmox_api
node_metrics_collection -.->|"stores metrics"| node_database
node_metrics_api -.->|"serves metrics"| node_database
node_node_monitoring -->|"reads monitoring data"| node_database
node_user -->|"opens tickets"| node_support_tickets
node_support_tickets -.->|"notifies"| node_notifications
node_notifications -.->|"sends Telegram alerts"| node_telegram_bot
node_backup_jobs -.->|"backs up panel data"| node_database

click node_public_catalog "https://github.com/mortal2424/proxmox-billing-pub/blob/main/index.php"
click node_registration "https://github.com/mortal2424/proxmox-billing-pub/blob/main/login/register.php"
click node_user_portal "https://github.com/mortal2424/proxmox-billing-pub/blob/main/templates/my_vms.php"
click node_authentication "https://github.com/mortal2424/proxmox-billing-pub/blob/main/includes/auth.php"
click node_admin_portal "https://github.com/mortal2424/proxmox-billing-pub/blob/main/admin/index.php"
click node_cluster_node_admin "https://github.com/mortal2424/proxmox-billing-pub/blob/main/admin/add_cluster.php"
click node_vm_ordering "https://github.com/mortal2424/proxmox-billing-pub/blob/main/templates/order_vm.php"
click node_proxmox_api "https://github.com/mortal2424/proxmox-billing-pub/blob/main/includes/proxmox_functions.php"
click node_billing "https://github.com/mortal2424/proxmox-billing-pub/blob/main/admin/cron_charge.php"
click node_metrics_collection "https://github.com/mortal2424/proxmox-billing-pub/blob/main/api/collect_vm_metrics.php"
click node_metrics_api "https://github.com/mortal2424/proxmox-billing-pub/blob/main/api/get_vm_metrics.php"
click node_node_monitoring "https://github.com/mortal2424/proxmox-billing-pub/blob/main/admin/monitoring.php"
click node_database "https://github.com/mortal2424/proxmox-billing-pub/blob/main/includes/db.php"
click node_support_tickets "https://github.com/mortal2424/proxmox-billing-pub/blob/main/templates/support.php"
click node_notifications "https://github.com/mortal2424/proxmox-billing-pub/blob/main/admin/admin_functions.php"
click node_telegram_bot "https://github.com/mortal2424/proxmox-billing-pub/blob/main/bots/telegram_bot.php"
click node_backup_jobs "https://github.com/mortal2424/proxmox-billing-pub/blob/main/includes/backup_functions.php"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_public_catalog,node_registration,node_user_portal,node_authentication toneBlue
class node_admin_portal,node_cluster_node_admin,node_vm_ordering,node_proxmox_api,node_database toneAmber
class node_billing,node_metrics_collection,node_metrics_api,node_node_monitoring toneMint
class node_support_tickets,node_notifications,node_telegram_bot,node_backup_jobs toneRose
class node_visitor,node_user,node_proxmox_service toneIndigo
```

## Components

### Accounts and portal

- [Tariff catalog](https://github.com/mortal2424/proxmox-billing-pub/blob/main/index.php): `index.php`
- [Registration](https://github.com/mortal2424/proxmox-billing-pub/blob/main/login/register.php): `login/register.php`
- [User VM portal](https://github.com/mortal2424/proxmox-billing-pub/blob/main/templates/my_vms.php): `templates/my_vms.php`
- [Session auth](https://github.com/mortal2424/proxmox-billing-pub/blob/main/includes/auth.php): `includes/auth.php`

### Proxmox provisioning

- [Admin console](https://github.com/mortal2424/proxmox-billing-pub/blob/main/admin/index.php): `admin/index.php`
- [Cluster and node setup](https://github.com/mortal2424/proxmox-billing-pub/blob/main/admin/add_cluster.php): `admin/add_cluster.php`
- [VM ordering](https://github.com/mortal2424/proxmox-billing-pub/blob/main/templates/order_vm.php): `templates/order_vm.php`
- [Proxmox operations](https://github.com/mortal2424/proxmox-billing-pub/blob/main/includes/proxmox_functions.php): `includes/proxmox_functions.php`

### Billing and monitoring

- [Resource billing](https://github.com/mortal2424/proxmox-billing-pub/blob/main/admin/cron_charge.php): `admin/cron_charge.php`
- [Metric collection](https://github.com/mortal2424/proxmox-billing-pub/blob/main/api/collect_vm_metrics.php): `api/collect_vm_metrics.php`
- [Metrics endpoints](https://github.com/mortal2424/proxmox-billing-pub/blob/main/api/get_vm_metrics.php): `api/get_vm_metrics.php`
- [Node monitoring](https://github.com/mortal2424/proxmox-billing-pub/blob/main/admin/monitoring.php): `admin/monitoring.php`

### Support and backups

- [Support tickets](https://github.com/mortal2424/proxmox-billing-pub/blob/main/templates/support.php): `templates/support.php`
- [Email and Telegram alerts](https://github.com/mortal2424/proxmox-billing-pub/blob/main/admin/admin_functions.php): `admin/admin_functions.php`
- [Telegram bot](https://github.com/mortal2424/proxmox-billing-pub/blob/main/bots/telegram_bot.php): `bots/telegram_bot.php`
- [Backup operations](https://github.com/mortal2424/proxmox-billing-pub/blob/main/includes/backup_functions.php): `includes/backup_functions.php`

### Other components

- **Visitor**
- **Customer**
- **Proxmox cluster**
- [Application database](https://github.com/mortal2424/proxmox-billing-pub/blob/main/includes/db.php): `includes/db.php`

## Connections

- Visitor → Tariff catalog: browses (evidence: `index.php`)
- Visitor → Registration: registers
- Customer → User VM portal: manages VMs
- Customer → VM ordering: orders resources
- User VM portal → Session auth: checks session (evidence: `templates/my_vms.php`)
- VM ordering → Proxmox operations: invokes provisioning (evidence: `templates/order_vm.php`)
- Proxmox operations → Proxmox cluster: controls VMs
- Cluster and node setup → Proxmox cluster: configures infrastructure
- Admin console → Session auth: checks admin role (evidence: `admin/index.php`)
- Admin console → Application database: reads dashboard data (evidence: `admin/index.php`)
- Resource billing → Application database: charges accounts
- Metric collection → Proxmox operations: queries VM data (evidence: `api/collect_vm_metrics.php`)
- Metric collection → Application database: stores metrics (evidence: `api/collect_vm_metrics.php`)
- Metrics endpoints → Application database: serves metrics
- Node monitoring → Application database: reads monitoring data (evidence: `admin/monitoring.php`)
- Customer → Support tickets: opens tickets
- Support tickets → Email and Telegram alerts: notifies
- Email and Telegram alerts → Telegram bot: sends Telegram alerts
- Backup operations → Application database: backs up panel data (evidence: `includes/backup_functions.php`)
