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

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

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
 - Change network states (enable / disable)
 
Cédric's avatar
Cédric committed
20 21
- Display :
 - Power status
Cédric's avatar
Cédric committed
22
 - Uptime
Cédric's avatar
Cédric committed
23 24 25 26 27 28
 - Load average
 - Installed Memory
 - Commsumed Memory
 - Installed CPU
 - Disk Space (total)
 - Graphics (Memory, CPU, Networks, DIsk IO)
Cédric's avatar
Cédric committed
29
 - Network interfaces (Mac address and state)
Cédric's avatar
Cédric committed
30

Cédric's avatar
Cédric committed
31 32
- Admin display :
 - Per client assignation
Cédric's avatar
Cédric committed
33
 - Task history (need to implement link to ispconfig user and pve user for non admin version)
Cédric's avatar
Cédric committed
34
 - Network Interfaces (Vlan, Rate)
LEVEILLE's avatar
LEVEILLE committed
35 36

## Screenshots
Cédric's avatar
Cédric committed
37
See misc folder For some screenshot
Cédric's avatar
Cédric committed
38

root's avatar
root committed
39 40 41 42 43 44 45 46 47
## 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';
Cédric's avatar
Cédric committed
48
 - Please do not use your Proxmox root user !
Cédric's avatar
Cédric committed
49 50 51
- Enable the module -> /usr/local/ispconfig/interface/lib/config.inc.local.php
 - Add "proxmox" to the variable $conf['modules_available'] 
 - Dont forget to activate it for your Ispconfig user 
root's avatar
root committed
52
- Create MySQL table for this module -> misc/vm_proxmox.sql
Cédric's avatar
Cédric committed
53
 - If you are on multi-servers setup you have to do this on each server
root's avatar
root committed
54 55


Cédric's avatar
Cédric committed
56 57 58 59 60
## ToDo
- Admin function : 
 - Snapshot (add / remove)

- Display: 
Cédric's avatar
Cédric committed
61 62
 - Top menu icon.
 - NoVNC console integration (stuck for the moment ... :( )
root's avatar
root committed
63

Cédric's avatar
Cédric committed
64
# License
Cédric's avatar
Cédric committed
65
Copyright (c) 2017, Oricom Internet