From 33762e53b522269fad7e9bc50eedbe9eee5aaaa5 Mon Sep 17 00:00:00 2001 From: Aarnav Tale Date: Thu, 5 Dec 2024 02:06:46 -0500 Subject: [PATCH] chore: document the /admin endpoint --- docs/Advanced-Integration.md | 7 +++++++ docs/Basic-Integration.md | 4 ++++ 2 files changed, 11 insertions(+) diff --git a/docs/Advanced-Integration.md b/docs/Advanced-Integration.md index 3a7cfe3..b4bcefe 100644 --- a/docs/Advanced-Integration.md +++ b/docs/Advanced-Integration.md @@ -69,3 +69,10 @@ Currently there are 3 integration providers that can do this for you: - [Kubernetes Integration](/docs/integration/Kubernetes.md) - [Native Linux Integration](/docs/integration/Native.md) +Once configured, the Headplane UI will be available at the `/admin` path +of the server you deployed it on. This is currently not configurable unless +you build the Docker image yourself or run the Node.js server directly. + +Additionally, if you require access to health information for either Docker +or Kubernetes, the `/admin/healthz` path will be available. This is useful for +monitoring services like Prometheus or Grafana. diff --git a/docs/Basic-Integration.md b/docs/Basic-Integration.md index a5fd4fe..e6d7697 100644 --- a/docs/Basic-Integration.md +++ b/docs/Basic-Integration.md @@ -50,6 +50,10 @@ services: PORT: '3000' ``` +Once configured, the Headplane UI will be available at the `/admin` path +of the server you deployed it on. This is currently not configurable unless +you build the Docker image yourself or run the Node.js server directly. + > For a breakdown of each configuration variable, please refer to the [Configuration](/docs/Configuration.md) guide. > It explains what each variable does, how to configure them, and what the