Update Health Check documentation to include port

The health check always uses port 5000 unless a port is specified. This documentation is based on the README in https://github.com/dokku/docker-container-healthchecker
This commit is contained in:
Mike Dalton
2024-04-27 00:34:37 -04:00
committed by GitHub
parent 5909067547
commit 761c9592a6

View File

@@ -170,6 +170,7 @@ A healthcheck entry takes the following properties:
- `initialDelay`: (default: 0, unit: seconds) Number of seconds to wait after a container has started before triggering the healthcheck.
- `name`: (default: autogenerated) The name of the healthcheck. If unspecified, it will be autogenerated from the rest of the healthcheck information.
- `path`: (default: `/` - for http checks): An http path to check.
- `port`: (default: `5000`): Port to run healthcheck against.
- `timeout`: (default: `5` seconds): Number of seconds to wait before timing out a healthcheck.
- `type`: (default: `""` - none): Type of the healthcheck. Options: liveness, readiness, startup.
- `uptime`: (default: `""` - none): Amount of time the container must be alive before the container is considered healthy. Any restarts will cause this to check to fail, and this check does not respect retries.