move source files to src folder,

move localdb to config folder,
consolidate vars.js with localdb,
move service scripts to service folder
This commit is contained in:
2023-06-09 03:58:38 +00:00
parent 24df8df731
commit 485ba0120e
11 changed files with 63 additions and 54 deletions

View File

@@ -22,13 +22,14 @@ In Proxmox VE, follow the following steps:
## Installation - API
1. Clone this repo onto `Client Host`
2. Run `npm install` to initiaze the package requirements
3. Copy `vars.js.template` as `vars.js` and modify the following values:
3. Copy `localdb.json.template` as `localdb.json` and modify the following values:
- 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`
- domain - the base domain for the client and proxmox, ie `domain.tld`
- 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)
4. Start the service using `node .`, or call the provided shell script, or use the provided systemctl service script
4. You may also wish to confuigure users at this point as well. An example user config is shown in the template.
5. Start the service using `node .`, or call the provided shell script, or use the provided systemctl service script
## Installation - Reverse Proxy
1. Configure nginx or preferred reverse proxy to reverse proxy the client. The configuration should include at least the following:
@@ -47,4 +48,4 @@ server {
2. Start nginx with the new configurations by running `systemctl reload nginx`
## Result
After these steps, the ProxmoxAAS Client should be avaliable and fully functional at `client.<FQDN>`.
After these steps, the ProxmoxAAS Client should be avaliable and fully functional at `client.<FQDN>`.