summaryrefslogtreecommitdiff
path: root/PLAN.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-04-14 15:39:43 +0300
committerPaul Buetow <paul@buetow.org>2026-04-14 15:39:43 +0300
commit0534d00024ede58ffa83a7c715e68cc03e6f9328 (patch)
treefb1a8764e17305386d1650cd6fdff2707f4b8ffc /PLAN.md
parent299aa6727025c4f888ec2a38b8945ed39159a99c (diff)
Release 0.3.0 with daemon API and container packaging.
Document the full HTTP API surface, bump the version for the new daemon/upload/report capabilities, and add Docker build assets so goprecords can be packaged and deployed in f3s. Made-with: Cursor
Diffstat (limited to 'PLAN.md')
-rw-r--r--PLAN.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/PLAN.md b/PLAN.md
new file mode 100644
index 0000000..bacd8a8
--- /dev/null
+++ b/PLAN.md
@@ -0,0 +1,14 @@
+# mage goprecords a microservice
+
+* Should run as a daemon, e.g. `goprecords --daemon`
+* Should have a configurable database path to a local directory
+* Local database is simply the input dir of the current goprecords CLI tool
+* Introduce an API to generate the available output formats, also include a HTML output format. All should be configurable using a query-parameter to the API.
+* Introduce an API to let clients upload new uprecords. see example database at /home/paul/git/uprecords/stats so every client should be able to upload 5 different files, HOSTNAME.{txt,cur.txt,records,os.txt,cpuinfo.txt}.
+* Use token-based authentication (e.g. API keys or JWT) for upload endpoints.
+* Upload should simply work using a curl CLI command given the auth is provided in the HTTP header.
+* have a way to manage different auth keys per client. not via API but via a local database and a `goprecords --create-client-key HOSTNAME`.
+
+
+
+