You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add health check to Directus service in Docker Compose example
Add a healthcheck configuration to the directus service block and a
section explaining the /server/health and /server/ping endpoints. This
helps users who run other containers that need to wait for Directus.
Fixes#331
We're keeping this section light for now, but if you need examples for other database providers, let us know!
111
118
::
119
+
120
+
## Health Checks
121
+
122
+
The Docker Compose example above includes health checks for all services. If you run other containers that depend on Directus being ready, use `depends_on` with `condition: service_healthy` to wait for Directus to start accepting requests.
123
+
124
+
Directus exposes two endpoints for health monitoring:
125
+
126
+
- `/server/health`- returns detailed health status including database and cache connectivity. Returns a `503` if any dependency is unhealthy (for example, a missing email transport configuration).
127
+
- `/server/ping`- returns `pong` if the HTTP server is running, regardless of dependency status. Use this if you only need to confirm the server is accepting requests.
0 commit comments