Skip to content

Commit 26908e0

Browse files
DominicGBauerDominicGBauerbenitav
authored
feat: add healthchecks section to self host (#29)
* feat: add healthchecks section to self host * Update self-hosting/lifecycle-maintenance/healthchecks.mdx Co-authored-by: benitav <[email protected]> * Update self-hosting/lifecycle-maintenance/healthchecks.mdx Co-authored-by: benitav <[email protected]> --------- Co-authored-by: DominicGBauer <[email protected]> Co-authored-by: benitav <[email protected]>
1 parent 292854e commit 26908e0

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

mint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,7 @@
353353
"self-hosting/lifecycle-maintenance",
354354
"self-hosting/lifecycle-maintenance/securing-your-deployment",
355355
"self-hosting/lifecycle-maintenance/server-specs",
356+
"self-hosting/lifecycle-maintenance/healthchecks",
356357
"self-hosting/lifecycle-maintenance/telemetry"
357358
]
358359
},
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: "Healthchecks"
3+
---
4+
5+
<Info>
6+
This requires the Docker image to be `journeyapps/powersync-service:0.5.8` or later.
7+
</Info>
8+
9+
The following endpoints can be used to check your system:
10+
11+
### Startup:
12+
13+
You can use the `/probes/startup` endpoint to confirm the service has started up correctly.
14+
15+
A `200` status code shows the system has started up.
16+
17+
A `400` status code shows the system has **not** yet started.
18+
19+
### Liveness:
20+
21+
You can use the `/probes/liveness` endpoint to confirm the service is alive.
22+
23+
A `200` status code shows the system is alive.
24+
25+
A `400` status code shows the system is **not** alive.
26+
27+
<Tip>
28+
**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).
29+
</Tip>

0 commit comments

Comments
 (0)