From 730c6324f72303bc60cbe16f3fd50c920eeb8e48 Mon Sep 17 00:00:00 2001 From: Arthur Lu Date: Mon, 6 Jul 2026 23:51:10 +0000 Subject: [PATCH] add Readme --- Readme.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 Readme.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..7219b30 --- /dev/null +++ b/Readme.md @@ -0,0 +1,16 @@ +# ProxmoxAAS Fabric - In-Memory Cache for ProxmoxAAS Cluster State +ProxmoxAAS Fabric provides functionality for the API by caching an in-memory representation of the proxmox cluster's state which speeds up computation of resource usage statistics. + +## Installation + +### Prerequisites +- [ProxmoxAAS-API](https://git.tronnet.net/tronnet/ProxmoxAAS-API) +- Proxmox VE Cluster (v7.0+) + +### Installation - API +1. Download `proxmoxaas-fabric` binary and `template.config.json` file from releases +2. Rename `template.config.json` to `config.json` and modify the following values: + 1. `listenPort`: port for user-manager-api to bind and listen on + 2. `url`: url to the Proxmox API, ie `https://pve.domain.net/api2/json` + 3. `token`: the user(name), authentication realm (pam), token id, and token secrey key (uuid) + 4. `rebuildInterval` (***optional***): the interval on which to completely rebuild the cache