From 461bde7d7faa96311b08134f1395d83fb850c0ba Mon Sep 17 00:00:00 2001 From: "Scott E. Graves" Date: Wed, 13 Aug 2025 21:01:17 -0500 Subject: [PATCH] Update HTTP REST API --- HTTP-REST-API.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/HTTP-REST-API.md b/HTTP-REST-API.md index 75af72c..3dcaf4a 100644 --- a/HTTP-REST-API.md +++ b/HTTP-REST-API.md @@ -34,6 +34,24 @@ This document reflects the API **exactly as implemented** in the server code. > The server listens on `127.0.0.1:`, where `` comes from your runtime configuration (`config.json`). +### 🔑 Authentication Configuration + +The `ApiUser`, `ApiPassword`, and `ApiPort` settings are stored in your **`config.json`** file. +These values are **read directly by the server** at startup. + +**Example `config.json` snippet:** + +```json +{ + "ApiPassword": "", + "ApiPort": 10000, + "ApiUser": "repertory" +} +``` + +- **ApiUser** → Username for API authentication +- **ApiPassword** → Plaintext password (hashed internally during requests) +- **ApiPort** → Port number the API server listens on ---