dahjah/headplane
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

chore: document the /admin endpoint

Browse Source
This commit is contained in:
Aarnav Tale 2024-12-05 02:06:46 -05:00
parent 8867cca494
commit 33762e53b5
No known key found for this signature in database
2 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/Advanced-Integration.md
View File

@ -69,3 +69,10 @@ Currently there are 3 integration providers that can do this for you:
- [Kubernetes Integration](/docs/integration/Kubernetes.md) - [Kubernetes Integration](/docs/integration/Kubernetes.md)
- [Native Linux Integration](/docs/integration/Native.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.

4
docs/Basic-Integration.md
View File

@ -50,6 +50,10 @@ services:
PORT: '3000' 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 > For a breakdown of each configuration variable, please refer to the
[Configuration](/docs/Configuration.md) guide. [Configuration](/docs/Configuration.md) guide.
> It explains what each variable does, how to configure them, and what the > It explains what each variable does, how to configure them, and what the