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

Update README.md

Browse Source
This commit is contained in:
Arthur Lu 2023-04-18 22:54:20 -07:00 committed by GitHub
parent 9f6bf6a8ad
commit e8cbcbf4fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -11,7 +11,7 @@ ProxmoxAAS Client provides users of a proxmox based compute on demand service a
## Prerequisites ## Prerequisites
- Proxmox VE Cluster (v7.0+) - Proxmox VE Cluster (v7.0+)
- Reverse proxy server which can serve the client - Reverse proxy server which can proxy the client and API
- FQDN - FQDN
- Web server to host the ProxmoxAAS Client (ie Apache2) - Web server to host the ProxmoxAAS Client (ie Apache2)
@ -31,26 +31,10 @@ The supported setup is to use a reverse proxy to serve both the original Proxmox
After this step, the Client should be available on the `Client Host` at port `80` After this step, the Client should be available on the `Client Host` at port `80`
## Installation - Reverse Proxy
1. Configure nginx or preferred reverse proxy to reverse proxy the client. This can be done in the same file previously or in a new configuration file:
```
server {
listen 443 ssl;
server_name client.<FQDN>;
location / {
proxy_pass http://<Client Host>:80;
}
location /api/ {
proxy_pass http://<Client Host>:8080;
}
}
```
2. Restart nginx with the new configurations by running `systemctl restart nginx`
## Installation - Client Configuration ## Installation - Client Configuration
1. In the `Client Host`, navigate to the repo root folder, rename `vars.js.template` to `vars.js` and modify `API` withe the value `client.<FQDN>/api` 1. In the `Client Host`, navigate to the repo root folder, rename `vars.js.template` to `vars.js` and modify `API` withe the value `client.<FQDN>/api`
## API Installation ## API Installation
To install the API, go to [ProxmoxAAS API](https://github.com/tronnet-gh/ProxmoxAAS-API). This is required for the client to function. To install the API, go to [ProxmoxAAS API](https://github.com/tronnet-gh/ProxmoxAAS-API). This is required for the client to function. The API installation will also have steps for setting up the reverse proxy server.