From 252dce80cec74ae7e105e22b0d95441db90213a8 Mon Sep 17 00:00:00 2001 From: Matt Date: Sun, 15 Mar 2026 10:28:20 -0700 Subject: [PATCH] update readme --- README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b292bb9..bda2d1a 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,8 @@ -This is a local service that will keep a brief history of some system stats and broadcast simple system stats. +This is a local service that displays system properties and metrics based on a descriptor file. This application is built using Ansible and this Role should run on any Linux system. -Plan is a python service for a local API, this API will have Objects for system components (like CPU, Storage, RAM, Info) which will inherit the properties of the component object which will have common things like name, summary, live info, historical info. +The foundation is a python service which runs a local API. This API creates a System object which then creates Component objects and refreshes them periodically. There is an API for querying this data, and the data is also published to a redis channel. -There will be a web server stack in docker that will have an isolated network, nginx and js node and php apache, or whatever evolves +The web dashboard is built from a stack of Node.js, PHP, and nginx. The Node.js server handles the websocket, the PHP renders the HTML, and the nginx container proxies it all together so I can code with PHP while still getting websocket updates. -I want the local web service to show a web-based summary for the current system that can be seen locally at whatever IP I pick -The API will start with just responding to the local requests - -There will be a docker network named cosmostat-network at 192.168.37.0/24 - -I will create that network in init with a generic docker command so it's there for the API to bind to since I want to build the API first after init. This has to be at the bottom because that's where all the data comes from. Build the API. build the web files, build docker +The docker stack also uses a network on the 192.168.37.0/24 subnet, and secures all traffic to be within this subnet. The dashboard can only be accessed locally at port 80 on 192.168.37.1 when the secure_api variable is set to true.