mirror of
https://github.com/axllent/mailpit.git
synced 2026-04-26 08:45:54 +03:00
[GH-ISSUE #73] Healthcheck endpoint #47
Labels
No labels
awaiting feedback
bug
docker
documentation
enhancement
github_actions
invalid
pull-request
question
stale
wontfix
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
starred/mailpit#47
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
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.
@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/livezorhttp://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?
@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.
@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 👍
@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.