tronnet/ProxmoxAAS-Dashboard
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README.md with new instructions

Browse Source 
Signed-off-by: Arthur Lu <learthurgo@gmail.com>
This commit is contained in:
Arthur Lu 2023-01-19 20:40:22 +00:00
parent c5d14708d3
commit 44f5b2243a
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -13,6 +13,7 @@ ProxmoxAAS Client provides users of a proxmox based compute on demand service a
- Proxmox VE Cluster (v7.0+) - Proxmox VE Cluster (v7.0+)
- Reverse proxy server which serves the Proxmox VE Web GUI & API (ie nginx) - Reverse proxy server which serves the Proxmox VE Web GUI & API (ie nginx)
- Web server to host the ProxmoxAAS Client (ie Apache2) - Web server to host the ProxmoxAAS Client (ie Apache2)
- [ProxmoxAAS API](https://github.com/tronnet-gh/ProxmoxAAS-API)
## Notes ## Notes
The supported setup is to use a reverse proxy to serve both the original Proxmox web interface and ProxmoxAAS Client. It is possible other setups can work. Rather than provide specific steps to duplicate a certain setup, the steps included are intended as a guideline of steps required for proper function in most setups. The supported setup is to use a reverse proxy to serve both the original Proxmox web interface and ProxmoxAAS Client. It is possible other setups can work. Rather than provide specific steps to duplicate a certain setup, the steps included are intended as a guideline of steps required for proper function in most setups.
@ -20,7 +21,10 @@ The supported setup is to use a reverse proxy to serve both the original Proxmox
## Installation - Client ## Installation - Client
1. Install Apache2 or another HTTP server onto a container or vm, which will be `Client Host` 1. Install Apache2 or another HTTP server onto a container or vm, which will be `Client Host`
2. Clone this repo onto `Client Host`, the default location for web root is `/var/www/html/` 2. Clone this repo onto `Client Host`, the default location for web root is `/var/www/html/`
3. Configure Apache2 to serve the Client at port 80: 3. Navigate to the repo root folder and modify `vars.js` with the following:
- Assign the url for the Proxmox Web UI to `pveAPI`
- Assign the url for the Proxmox Client API to `paasAPI`
4. Configure Apache2 to serve the Client at port 80:
``` ```
<VirtualHost *:80> <VirtualHost *:80>
ServerAdmin webmaster@localhost ServerAdmin webmaster@localhost
@ -105,6 +109,18 @@ server {
proxy_send_timeout 3600s; proxy_send_timeout 3600s;
send_timeout 3600s; send_timeout 3600s;
} }
location /api/ {
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_pass http://<Client Host IP or DN>:8080;
proxy_buffering off;
client_max_body_size 0;
proxy_connect_timeout 3600s;
proxy_read_timeout 3600s;
proxy_send_timeout 3600s;
send_timeout 3600s;
}
location '/.well-known/acme-challenge' { location '/.well-known/acme-challenge' {
default_type "text/plain"; default_type "text/plain";
root /var/www/html; root /var/www/html;
@ -113,4 +129,4 @@ server {
``` ```
3. Restart nginx with the new configurations by running `systemctl restart nginx` 3. Restart nginx with the new configurations by running `systemctl restart nginx`
After this step, the Proxmox web UI will be avaliable at pve.\<FQDN\> and the PAAS Client will be avaliable at client.\<FQDN\> After this step, the Proxmox web UI will be avaliable at pve.\<FQDN\> and the PAAS Client will be avaliable at client.\<FQDN\>