From 44f5b2243a9998a82966ce331af2e20c9980b5b1 Mon Sep 17 00:00:00 2001 From: Arthur Lu Date: Thu, 19 Jan 2023 20:40:22 +0000 Subject: [PATCH] update README.md with new instructions Signed-off-by: Arthur Lu --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c4d0869..6014187 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ ProxmoxAAS Client provides users of a proxmox based compute on demand service a - Proxmox VE Cluster (v7.0+) - Reverse proxy server which serves the Proxmox VE Web GUI & API (ie nginx) - Web server to host the ProxmoxAAS Client (ie Apache2) +- [ProxmoxAAS API](https://github.com/tronnet-gh/ProxmoxAAS-API) ## 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. @@ -20,7 +21,10 @@ The supported setup is to use a reverse proxy to serve both the original Proxmox ## Installation - Client 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/` -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: ``` ServerAdmin webmaster@localhost @@ -105,6 +109,18 @@ server { proxy_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://: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' { default_type "text/plain"; root /var/www/html; @@ -113,4 +129,4 @@ server { ``` 3. Restart nginx with the new configurations by running `systemctl restart nginx` -After this step, the Proxmox web UI will be avaliable at pve.\ and the PAAS Client will be avaliable at client.\ +After this step, the Proxmox web UI will be avaliable at pve.\ and the PAAS Client will be avaliable at client.\ \ No newline at end of file