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

change name from client to dashboard

Browse Source
This commit is contained in:
Arthur Lu 2023-09-15 07:02:42 +00:00
parent bdd428215b
commit 6d9b5279fb
1 changed files with 17 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,8 +1,8 @@
# ProxmoxAAS Client - Proxmox As A Service User Interface # ProxmoxAAS Dashboard - Proxmox As A Service User Web Interface
ProxmoxAAS Client provides users of a proxmox based compute on demand service a simplified UI which gives users power management, console access, and instance configuration utility. It also allows administrators to set resource quotas for users and allows users to configure instances without administrator priviledges. ProxmoxAAS Dashboard provides users of a proxmox based compute on demand service a simplified UI which gives users power management, console access, and instance configuration utility. It also allows administrators to set resource quotas for users and allows users to configure instances without administrator priviledges.
## Features ## Features
- Simplified interface for clients - Simplified interface for non administrator users
- Instance power management - Instance power management
- Instance resource configuration - Instance resource configuration
- Instance creation and destruction - Instance creation and destruction
@ -11,31 +11,30 @@ 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 proxy the client and API - Reverse proxy server which can proxy the dashboard and API
- FQDN - FQDN
- Web server to host the ProxmoxAAS Client (ie Apache2) - Web server to host the ProxmoxAAS Dashboard (ie Apache2)
## 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. Consequently, the examples provided are only to highlight key settings and do not represent complete working configurations. The instructions also assume you have your own domain name which will substitute `<FQDN>` in some of the configs. The supported setup is to use a reverse proxy to serve both the original Proxmox web interface and ProxmoxAAS Dashboard. 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. Consequently, the examples provided are only to highlight key settings and do not represent complete working configurations. The instructions also assume you have your own domain name which will substitute `<FQDN>` in some of the configs.
## Installation - Client ## Installation - Dashboard
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 `Dashboard Host`
2. Clone this repo onto `Client Host`, the default location for web root is `/var/www/html/` 2. Clone this repo onto `Dashboard Host`, the default location for web root is `/var/www/html/`
4. Configure Apache2 to serve the Client at port 80 by adding the file `client.conf` to `/etc/apache2/sites-avaliable/` with at least the following: 4. Configure Apache2 to serve the app at port 80 by adding the file `dashboard.conf` to `/etc/apache2/sites-avaliable/` with at least the following:
``` ```
<VirtualHost *:80> <VirtualHost *:80>
DocumentRoot /var/www/html/ProxmoxAAS-Client/ DocumentRoot /var/www/html/ProxmoxAAS-Dashboard/
</VirtualHost> </VirtualHost>
``` ```
4. Enable the Client site by running `a2ensite client` 4. Enable the site by running `a2ensite dashboard`
After this step, the Client should be available on the `Client Host` at port `80` After this step, the Dashboard should be available on the `Dashboard Host` at port `80`
## Configuration - Client
1. In `Client Host`, navigate to this repo's root folder
2. Rename `tempalte.vars.js` to `vars.js` and assign the `API` variable with the value of the API's URL. This will likely be `client.<FQDN>/api`
## Configuration - Dashboard
1. In `Dashboard Host`, navigate to this repo's root folder
2. Rename `template.vars.js` to `vars.js` and assign the `API` variable with the value of the API's URL. This will likely be `dashboard.<FQDN>/api`
## Installation - API ## Installation - API
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. To install the API, go to [ProxmoxAAS API](https://github.com/tronnet-gh/ProxmoxAAS-API). This is required for the app to function. The API installation will also have steps for setting up the reverse proxy server.