Skip to content
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

Jump to bottom

Health Check API #992

Closed
4 tasks done
trekie86 opened this issue Oct 25, 2022 · 2 comments
Closed
4 tasks done

Health Check API #992

trekie86 opened this issue Oct 25, 2022 · 2 comments
Labels
question Further information is requested released

Comments

@trekie86
Copy link

Describe your suggested feature

I use a program called Uptime-Kuma to monitor my self-hosted services. Rather than hitting the Komga webpage and waiting for the site to render before returning a 200 OK, it would be great to add a health check to the REST APIs that can be used for lightweight status checks.

I checked the OpenAPI spec: https://github.com/gotson/komga/blob/master/komga/docs/openapi.json and did not find any endpoints that would fit this need. Additionally, it would be great if this health check could run without auth so that external tools can integrate easily and not pass around basic credentials across the wire.

Other details

No response

Acknowledgements

  • I have searched the existing issues and this is a new ticket, NOT a duplicate or related to another open issue.
  • I have written a short but informative title.
  • I have updated the app to the latest version.
  • I will fill out all of the requested information in this form.
@gotson gotson added question Further information is requested and removed triage labels Oct 26, 2022
@gotson
Copy link
Owner

gotson commented Oct 26, 2022

Komga uses Spring Boot, which includes management APIs, and one endpoint displays the health status. You can find it at /actuator/health.

Currently the actuator endpoints are limited to ADMIN roles. I will do a small change to allow the health endpoint to show limited details to unauthorized users.

@gotson gotson closed this as completed in 751d347 Oct 26, 2022
github-actions bot pushed a commit that referenced this issue Oct 30, 2022
@semantic-release-bot
chore(release): 0.157.3 [skip ci]
16091d4 
## [0.157.3](v0.157.2...v0.157.3) (2022-10-30)

### Bug Fixes

* **api:** allow unauthorized access to health endpoint ([751d347](751d347)), closes [#992](#992)
* translated using Weblate ([3f4aa33](3f4aa33))
* **webui:** add debouncer when searching for author in Edit Book dialog ([da3d283](da3d283)), closes [#960](#960)
@github-actions
Copy link
Contributor

🎉 This issue has been resolved in version 0.157.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
question Further information is requested released
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gotson @trekie86