Skip to content

Commit

Permalink
Add health endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
@Bubka
Bubka committed Sep 25, 2024
1 parent 4324938 commit 2a31e1a
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/Usage/administration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,3 +204,9 @@ This is not a soft delete. Deleted account cannot be recovered.
!!!warning
There must always be at least one administrator. The last administrator account cannot be deleted.
!!!

## Health check

2FAuth provides a special URL to check its health: `/up`

This is a very lightweight resource that responds with a `200` HTTP status code when the application is up and running. It can be used to set up a Docker HEALTHCHECK or a Kubernetes HTTPS liveness probe.

0 comments on commit 2a31e1a

Please sign in to comment.