[GH-ISSUE #73] Healthcheck endpoint #47

Closed
opened 2026-03-15 12:17:02 +03:00 by kerem · 4 comments
Owner

Originally created by @IgnisDa on GitHub (Mar 25, 2023).
Original GitHub issue: https://github.com/axllent/mailpit/issues/73

Hello, awesome project! Could a healthcheck endpoint be added? Just an endpoint that can be used to check if the service is healthy. It is useful in docker-compose etc.

Originally created by @IgnisDa on GitHub (Mar 25, 2023). Original GitHub issue: https://github.com/axllent/mailpit/issues/73 Hello, awesome project! Could a healthcheck endpoint be added? Just an endpoint that can be used to check if the service is healthy. It is useful in docker-compose etc.
kerem closed this issue 2026-03-15 12:17:07 +03:00
Author
Owner

@axllent commented on GitHub (Mar 25, 2023):

Hi @IgnisDa . There are actually already two kubernetes-specific handlers which should both work for what you want, namely http://localhost:8025/livez or http://localhost:8025/readyz. I was considering adding this to the Dockerfile, however it would only work if using the default 8025 port and HTTP - if the user specifies another port or TLS via either an environment variable or command-line option it would fail, so I haven't implemented this.

Does this help?

<!-- gh-comment-id:1483781498 --> @axllent commented on GitHub (Mar 25, 2023): Hi @IgnisDa . There are actually already two kubernetes-specific handlers which should both work for what you want, namely `http://localhost:8025/livez` or `http://localhost:8025/readyz`. I was considering adding this to the Dockerfile, however it would only work if using the default 8025 port and HTTP - if the user specifies another port or TLS via either an environment variable or command-line option it would fail, so I haven't implemented this. Does this help?
Author
Owner

@IgnisDa commented on GitHub (Mar 25, 2023):

Yep it does work. Would be worth documenting them on https://github.com/axllent/mailpit/tree/develop/docs/apiv1.

<!-- gh-comment-id:1483783623 --> @IgnisDa commented on GitHub (Mar 25, 2023): Yep it does work. Would be worth documenting them on https://github.com/axllent/mailpit/tree/develop/docs/apiv1.
Author
Owner

@axllent commented on GitHub (Mar 25, 2023):

Thanks for the feedback. Actually any of those API calls should technically work too. Given that this isn't necessarily an API-related feature but more of a system-related feature, I have now documented them on the website 👍

<!-- gh-comment-id:1483784398 --> @axllent commented on GitHub (Mar 25, 2023): Thanks for the feedback. Actually any of those API calls should technically work too. Given that this isn't necessarily an API-related feature but more of a system-related feature, I have now documented them on the [website](https://mailpit.axllent.org/docs/integration/healthcheck/) :+1:
Author
Owner

@99linesofcode commented on GitHub (Jan 8, 2024):

Perhaps it would be more obvious to others but I quickly checked here to determine that the endpoint is exposed on the dashboard and not on the mailpit service itself. Might be worth mentioning in the documentation.

<!-- gh-comment-id:1880983335 --> @99linesofcode commented on GitHub (Jan 8, 2024): Perhaps it would be more obvious to others but I quickly checked here to determine that the endpoint is exposed on the dashboard and not on the mailpit service itself. Might be worth mentioning in the documentation.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/mailpit#47
No description provided.