chore: document the /admin endpoint

tale · Dec 5, 2024 · 33762e5 · 33762e5
1 parent 8867cca
commit 33762e5
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git 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
@@ -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