From 6a9c54562cb71b9f099eb4ef0d10dc3062672c78 Mon Sep 17 00:00:00 2001 From: MzUgM <108896003+MzUgM@users.noreply.github.com> Date: Wed, 13 Sep 2023 20:59:55 -0700 Subject: [PATCH] docs: note where healthcheck endpoint is located This information is available in the under-pressure documentation but it is a little bit buried --- .../version-0.41.1/reference/service/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-0.41.1/reference/service/configuration.md b/versioned_docs/version-0.41.1/reference/service/configuration.md index 6f5357f466..937a8387c4 100644 --- a/versioned_docs/version-0.41.1/reference/service/configuration.md +++ b/versioned_docs/version-0.41.1/reference/service/configuration.md @@ -48,7 +48,7 @@ A **required** object with the following settings: - **`hostname`** (**required**, `string`) — Hostname where Platformatic Service server will listen for connections. - **`port`** (**required**, `number`) — Port where Platformatic Service server will listen for connections. -- **`healthCheck`** (`boolean` or `object`) — Enables the health check endpoint. +- **`healthCheck`** (`boolean` or `object`) — Enables the health check endpoint, located at `/status`. - Powered by [`@fastify/under-pressure`](https://github.com/fastify/under-pressure). - The value can be an object, used to specify the interval between checks in milliseconds (default: `5000`)