README.md 1.33 KB
Newer Older
Cédric's avatar
Cédric committed
1 2
# ISPCONFIG Module

Cédric's avatar
Cédric committed
3
## Application informations 
Cédric's avatar
Cédric committed
4 5
 This application is an Add-ons for ISPConfig used for VPS Management (Proxmox)

Cédric's avatar
Cédric committed
6 7
## Requirements
- ISPConfig 3.1
Cédric's avatar
Cédric committed
8
- Mysql database (same as ISPconfig)
Cédric's avatar
Cédric committed
9
- Proxmox Virtual Environement
root's avatar
root committed
10
- Firewall permission
Cédric's avatar
Cédric committed
11

Cédric's avatar
Cédric committed
12
## Features 
Cédric's avatar
Cédric committed
13 14 15
- Manage your VPS :
 - Start
 - Shutdown
Cédric's avatar
Cédric committed
16 17
 - Reset
 - Hard Stop (unplug the power)
Cédric's avatar
Cédric committed
18 19 20

- Display :
 - Power status
Cédric's avatar
Cédric committed
21
 - Uptime
Cédric's avatar
Cédric committed
22 23 24 25 26 27
 - Load average
 - Installed Memory
 - Commsumed Memory
 - Installed CPU
 - Disk Space (total)
 - Graphics (Memory, CPU, Networks, DIsk IO)
Cédric's avatar
Cédric committed
28

Cédric's avatar
Cédric committed
29 30
- Admin display :
 - Per client assignation
Cédric's avatar
Cédric committed
31

root's avatar
root committed
32
## ToDo
Cédric's avatar
Cédric committed
33
- Admin function : 
Cédric's avatar
Cédric committed
34
 - Snapshot (add / remove)
Cédric's avatar
Cédric committed
35
 - Networks : Enable / Disable, Vlan, rate limit
Cédric's avatar
Cédric committed
36

Cédric's avatar
Cédric committed
37 38
- Display: 
 - Event log
Cédric's avatar
Cédric committed
39
 - Vps consol integration
Cédric's avatar
Cédric committed
40

root's avatar
root committed
41 42 43 44 45 46 47 48 49 50 51 52 53
## How To implement this module
- Create Proxmox user for ISPConfig communication with PVEVMUser right
 - Assign VMs to this user
- Deploy the module into your ISPConfig setup -> /usr/local/ispconfig/interface/web
- Configure the module with your Proxmox user -> /usr/local/ispconfig/interface/lib/config.inc.local.php
 - $conf["pve_username"] 	= 'username';
 - $conf["pve_password"] 	= 'password';
 - $conf["pve_link"] 		= 'hostname / ip of your cluster head';
 - $conf["pve_realm"] 		= 'realm';
- Create MySQL table for this module -> misc/vm_proxmox.sql



Cédric's avatar
Cédric committed
54
# License
Cédric's avatar
Cédric committed
55
Copyright (c) 2016, Oricom Internet
root's avatar
root committed
56
All rights reserved.