external/HyperProxmox
1
0
Fork 0
mirror of https://github.com/ThomasGsp/HyperProxmox.git synced 2025-02-15 04:32:15 +00:00
Code Issues Releases Wiki Activity

Update readme

Browse source
This commit is contained in:
Tlams 2018-04-25 22:38:46 +01:00
parent 5baf7c7122
commit 19dd43087d
1 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -7,25 +7,27 @@
* Object : Massive LXC CT / KVM deployment and management system for Proxmox clusters. * Object : Massive LXC CT / KVM deployment and management system for Proxmox clusters.
* Information : * Information :
This project is currently in active development. This project is currently in active development.
You shouldn't use in production mode, use at your risks ! You shouldn't use in production mode or... use at your risks !
* Proxmox version supported: 3.x/4.x/5/x * Proxmox version supported: 3.x/4.x/5/x
## Version informations: ## Version informations:
* Provide: * Provide:
- Basic web interface to list instances, nodes and clusters (with details) - Basic web interface to list instances, nodes and clusters
- Basic instance management by the web interface(stop/start/restart...) - Basic instance management (stop/start/restart...)
- Proxmox data crawler - Data crawler
- API for the system management and data - API
- Encipher the critical data (cluster access) - Encipher the critical data (cluster access)
- LDAP authentication for web interface - LDAP authentication for web interface
- Group & cluster viewing in web interface - Group & cluster viewing in web interface
* In progress:
- Advanced logs system
- Purge old data
* Not provide: * Not provide:
- Advanced security **(Not API authentication - DO NOT EXPOSE API WITHOUT AN AUTHENTICATION PROXY)** - Advanced security **(Not API authentication - DO NOT EXPOSE API WITHOUT AN AUTHENTICATION PROXY)**
- Instance deployment - Instance deployment
- Advanced logs system
- Purge data system
- Lot of others things - Lot of others things
## Requirement: ## Requirement:
@ -41,7 +43,7 @@ You shouldn't use in production mode, use at your risks !
* Web stack * Web stack
* Nginx * Nginx
* PHP7 * PHP7
* php-curl, php-mysql, php7.0-json * php-curl, php7.0-json
* Python softwares * Python softwares
* Version 3.5+ * Version 3.5+
@ -139,8 +141,6 @@ chown hyperproxmox: /var/log/hyperproxmox/
rm /opt/HyperProxmox/code/scripts/main/private/keys/Ragnarok.p* rm /opt/HyperProxmox/code/scripts/main/private/keys/Ragnarok.p*
``` ```
```
``` bash ``` bash
# Configurations # Configurations
vi /opt/HyperProxmox/code/scripts/main/private/conf/config vi /opt/HyperProxmox/code/scripts/main/private/conf/config
@ -197,7 +197,8 @@ curl -H -XPOST -d '{
"exclude_nodes": ["node_shit1"], "exclude_nodes": ["node_shit1"],
"groups" : ["group1", "group2..."], "groups" : ["group1", "group2..."],
"weight": 1 "weight": 1
}' localhost:8080/api/v1/administration/cluster/Cluster_B }' localhost:8080/api/v1/administration/cluster/Cluster_B*
``` ```
* "name": Symbolic cluster name. Should be uniq (string) [VALUE NOT EMPTY REQUIRED] * "name": Symbolic cluster name. Should be uniq (string) [VALUE NOT EMPTY REQUIRED]
@ -221,7 +222,6 @@ curl -H -XPOST -d '{
## API Information ## API Information
### General informations ### General informations
``` bash
### Instance status management ### Instance status management
``` bash ``` bash