Skip to content

docs: add healthcheck example #14176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HsukqiLee wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

docs: add healthcheck example #14176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions AI_AGENT_DISCLOSURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
This contribution was prepared by an AI agent acting on a human's behalf.
The human submitter may not have independently reviewed or tested the change.

2026-09-03
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,18 @@ services:
- "5000:5000"
volumes:
- .:/code
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:5000"]
interval: 30s
redis:
image: redis
```

The `healthcheck` tells Compose how to determine whether a service is healthy. In
this example, Compose runs `curl` inside the `web` container every 30 seconds
to check port 5000 and considers the service healthy when the HTTP request
succeeds. The image built for `web` must include `curl`.

Contributing
------------

Expand Down