diff --git a/README.md b/README.md index 36ff4be..cbae84d 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ ProxmoxAAS Dashboard provides users of a proxmox based compute on demand service ## ProxmoxAAS System Installation Overview -The ProxmoxAAS project is large and is split into multiple components. There are three required components, the Dashboard, API, and Fabric. There is also an optional LDAP component for organizations that want to use LDAP as their authentication backend. The instalation order should start with the Dashboard and then proceed to the other backend components. This will require some foresight into the setup process. +The ProxmoxAAS project is large and is split into multiple components. There are four required components, the Dashboard, API, Fabric, and access-manager-api. The instalation order should start with the Dashboard and then proceed to the other backend components. This will require some foresight into the setup process. The supported setup is to use a reverse proxy to serve both the original Proxmox web interface and ProxmoxAAS components. 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 `domain.net` in some of the configs. @@ -25,7 +25,7 @@ We will assume different hosts for each component which are accessible by unique | ProxmoxAAS-Dashboard | dashboard.local | paas.domain.net | | ProxmoxAAS-API | api.local | paas.domain.net/api/ | | ProxmoxAAS-Fabric | fabric.local | N/A | -| ProxmoxAAS-LDAP | ldap.local | N/A| +| access-manager-api | access.local | N/A| ## Prerequisites - Dashboard - Proxmox VE Cluster (v7.0+) @@ -36,11 +36,11 @@ We will assume different hosts for each component which are accessible by unique 1. Initialize any host, which will be the `ProxmoxAAS-Dashboard` component host 2. Download `proxmoxaas-dashboard` binary and `template.config.json` file from [releases](https://git.tronnet.net/tronnet/ProxmoxAAS-LDAP/releases) Rename `template.config.json` to `config.json` and modify: - - listenPort: port for PAAS-Dashboard to bind and listen on - - organization: name of your org which is displayed on the top left corner - - dashurl: url for the dashboard, ie. `https://paas.domain.net` - - apiurl: url for PAAS-API, ie. `https://paas.domain.net/api` - - pveurl: url for the Proxmox endpoint, ie. `https://pve.domain.net` + - `listenPort`: port for PAAS-Dashboard to bind and listen on + - `organization`: name of your org which is displayed on the top left corner + - `dashurl`: url for the dashboard, ie. `https://paas.domain.net` + - `apiurl`: url for PAAS-API, ie. `https://paas.domain.net/api` + - `pveurl`: url for the Proxmox endpoint, ie. `https://pve.domain.net` 3. Execute the binary or additionally download `proxmoxaas-dashboard.service` from [releases](https://git.tronnet.net/tronnet/ProxmoxAAS-LDAP/releases) to run using systemd After this step, the Dashboard should be available on the `ProxmoxAAS-Dashboard` host at the configured `listenPort` @@ -53,9 +53,9 @@ To install the API component, go to [ProxmoxAAS-API](https://git.tronnet.net/tro To install the Fabric component, go to [ProxmoxAAS-Fabric](https://git.tronnet.net/tronnet/ProxmoxAAS-Fabric). This is required for the app to function. The Fabric installation will also have steps for setting up the reverse proxy server. -## Installation - LDAP +## Installation - access-manager-api -To install the LDAP component, go to [ProxmoxAAS-LDAP](https://git.tronnet.net/tronnet/ProxmoxAAS-LDAP).This is an optional component which adds a lightweight REST API server ontop of a simplified LDAP environment. It is only used by the API as a potential authentication backend. +To install the access-manager-api component, go to [access-manager-api](https://git.tronnet.net/tronnet/access-manager-api). This is required for the app to function. The access-manager-api installation will also have steps for setting up the reverse proxy server. ## Installation - Reverse Proxy 1. Configure nginx or preferred reverse proxy to reverse proxy the dashboard. The configuration should include at least the following, ensuring that the configured ports are adjusted appropriately: