Skip to content

Commit 8d85bb9

Browse files
alexjustesengitbook-bot
authored andcommitted
GITBOOK-73: change request with no subject merged in GitBook
1 parent 4eff90b commit 8d85bb9

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
* [Commands](other/commands.md)
4040
* [Data Dictionary](other/data-dictionary.md)
4141
* [Embed Dashboard](other/embed-dashboard.md)
42+
* [Health Check](other/health-check.md)
4243

4344
## 🖥 API
4445

other/health-check.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Health Check
2+
3+
Using the health check URL you can test to make sure the application is up and working. The URL `/api/healthcheck` will response with a 200 HTTP response code and a JSON message.
4+
5+
### Health Check Endpoint
6+
7+
```bash
8+
curl {APP_URL}/api/healthcheck
9+
```
10+
11+
You can also add this to your Docker Compose file so the Docker service can monitor that the container has started successfully.
12+
13+
```docker
14+
healthcheck:
15+
test: curl -fSs {APP_URL}/api/healthcheck || exit 1
16+
interval: 10s
17+
retries: 3
18+
start_period: 30s
19+
timeout: 10s
20+
```
21+
22+
### Response
23+
24+
```json
25+
{"message":"Speedtest Tracker is running!"}
26+
```

0 commit comments

Comments
 (0)