diff --git a/mint.json b/mint.json index 405f1dc..d0b4263 100644 --- a/mint.json +++ b/mint.json @@ -353,6 +353,7 @@ "self-hosting/lifecycle-maintenance", "self-hosting/lifecycle-maintenance/securing-your-deployment", "self-hosting/lifecycle-maintenance/server-specs", + "self-hosting/lifecycle-maintenance/healthchecks", "self-hosting/lifecycle-maintenance/telemetry" ] }, diff --git a/self-hosting/lifecycle-maintenance/healthchecks.mdx b/self-hosting/lifecycle-maintenance/healthchecks.mdx new file mode 100644 index 0000000..6799f18 --- /dev/null +++ b/self-hosting/lifecycle-maintenance/healthchecks.mdx @@ -0,0 +1,29 @@ +--- +title: "Healthchecks" +--- + + + This requires the Docker image to be `journeyapps/powersync-service:0.5.8` or later. + + +The following endpoints can be used to check your system: + +### Startup: + +You can use the `/probes/startup` endpoint to confirm the service has started up correctly. + +A `200` status code shows the system has started up. + +A `400` status code shows the system has **not** yet started. + +### Liveness: + +You can use the `/probes/liveness` endpoint to confirm the service is alive. + +A `200` status code shows the system is alive. + +A `400` status code shows the system is **not** alive. + + +**Example**: An example configuration with Docker Compose is available in the [self-host-demo app](https://github.com/powersync-ja/self-host-demo/blob/main/services/powersync.yaml). +