fix dashboard in readme
This commit is contained in:
parent
57219020df
commit
05ab27c48f
20
README.md
20
README.md
@ -2,9 +2,9 @@
|
|||||||
ProxmoxAAS API provides functionality for the Dashboard by providing a proxy API for the Proxmox API, and an API for requesting resources within a defined quota.
|
ProxmoxAAS API provides functionality for the Dashboard by providing a proxy API for the Proxmox API, and an API for requesting resources within a defined quota.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
- [ProxmoxAAS-Client](https://git.tronnet.net/tronnet/ProxmoxAAS-Dashboard)
|
- [ProxmoxAAS-Dashboard](https://git.tronnet.net/tronnet/ProxmoxAAS-Dashboard)
|
||||||
- Proxmox VE Cluster (v7.0+)
|
- Proxmox VE Cluster (v7.0+)
|
||||||
- Reverse proxy server which can proxy the client and API
|
- Reverse proxy server which can proxy the dashboard and API
|
||||||
- FQDN
|
- FQDN
|
||||||
- Server with NodeJS (v18.0+) and NPM installed
|
- Server with NodeJS (v18.0+) and NPM installed
|
||||||
|
|
||||||
@ -21,12 +21,12 @@ In Proxmox VE, follow the following steps:
|
|||||||
5. Add a new User Permission with path: `/`, select the `proxmoxaas-api` user, and role: `proxmoxaas-api`
|
5. Add a new User Permission with path: `/`, select the `proxmoxaas-api` user, and role: `proxmoxaas-api`
|
||||||
|
|
||||||
## Installation - API
|
## Installation - API
|
||||||
1. Clone this repo onto `Client Host`
|
1. Clone this repo onto `Dashboard Host`
|
||||||
2. Run `npm install` to initiaze the package requirements
|
2. Run `npm install` to initiaze the package requirements
|
||||||
3. Copy `template.localdb.json` as `localdb.json` and modify the following values under `pveAPIToken`:
|
3. Copy `template.localdb.json` as `localdb.json` and modify the following values under `pveAPIToken`:
|
||||||
- pveAPI - the URI to the Proxmox API, ie `<proxmoxhost>:8006/api2/json` or `<proxmox URL>/api2/json` if Proxmox VE is behind a reverse proxy.
|
- pveAPI - the URI to the Proxmox API, ie `<proxmoxhost>:8006/api2/json` or `<proxmox URL>/api2/json` if Proxmox VE is behind a reverse proxy.
|
||||||
- hostname - the ProxmoxAAS-Client URL, ie `host.domain.tld`
|
- hostname - the ProxmoxAAS-Dashboard URL, ie `host.domain.tld`
|
||||||
- domain - the base domain for the client and proxmox, ie `domain.tld`
|
- domain - the base domain for the dashboard and proxmox, ie `domain.tld`
|
||||||
- listenPort - the port you want the API to listen on, ie `8080`
|
- listenPort - the port you want the API to listen on, ie `8080`
|
||||||
- pveAPIToken - the user(name), authentication realm, token id, and token secrey key (uuid)
|
- pveAPIToken - the user(name), authentication realm, token id, and token secrey key (uuid)
|
||||||
4. (Optional) In order to allow users to customize instance pcie devices, the API must use the root credentials for privilege elevation. Modify the following values under `pveroot` in order to use this feature:
|
4. (Optional) In order to allow users to customize instance pcie devices, the API must use the root credentials for privilege elevation. Modify the following values under `pveroot` in order to use this feature:
|
||||||
@ -36,20 +36,20 @@ In Proxmox VE, follow the following steps:
|
|||||||
6. Start the service using `node .`, or call the provided shell script, or use the provided systemctl service script
|
6. Start the service using `node .`, or call the provided shell script, or use the provided systemctl service script
|
||||||
|
|
||||||
## Installation - Reverse Proxy
|
## Installation - Reverse Proxy
|
||||||
1. Configure nginx or preferred reverse proxy to reverse proxy the client. The configuration should include at least the following:
|
1. Configure nginx or preferred reverse proxy to reverse proxy the dashboard. The configuration should include at least the following:
|
||||||
```
|
```
|
||||||
server {
|
server {
|
||||||
listen 443 ssl;
|
listen 443 ssl;
|
||||||
server_name client.<FQDN>;
|
server_name dashboard.<FQDN>;
|
||||||
location / {
|
location / {
|
||||||
proxy_pass http://<Client Host>:80;
|
proxy_pass http://<Dashboard Host>:80;
|
||||||
}
|
}
|
||||||
location /api/ {
|
location /api/ {
|
||||||
proxy_pass http://<Client Host>:8080;
|
proxy_pass http://<Dashboard Host>:8080;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
2. Start nginx with the new configurations by running `systemctl reload nginx`
|
2. Start nginx with the new configurations by running `systemctl reload nginx`
|
||||||
|
|
||||||
## Result
|
## Result
|
||||||
After these steps, the ProxmoxAAS Client should be available and fully functional at `dashboard.<FQDN>`.
|
After these steps, the ProxmoxAAS Dashboard should be available and fully functional at `dashboard.<FQDN>`.
|
@ -13,7 +13,7 @@
|
|||||||
"password": "rootpassword"
|
"password": "rootpassword"
|
||||||
},
|
},
|
||||||
"listenPort": 80,
|
"listenPort": 80,
|
||||||
"hostname": "client.mydomain.example",
|
"hostname": "dashboard.mydomain.example",
|
||||||
"domain": "mydomain.example"
|
"domain": "mydomain.example"
|
||||||
},
|
},
|
||||||
"resources": {
|
"resources": {
|
||||||
|
Loading…
Reference in New Issue
Block a user