1
0
mirror of https://github.com/imgproxy/imgproxy.git synced 2024-12-09 09:56:01 +02:00
imgproxy/docs/healthcheck.md
Travis-Turner c51521961f
Docs/edits overhaul (#785)
* Update landing page / README.md

* Update GETTING_STARTED.md

* Update installation.md

* Update getting_the_image_info.md

* update signing_the_url.md

* Update watermark.md

* Update presets.md

* Update object_detection.md

* Update autoquality.md

* Update serving_local_files.md

* Update docs/serving_files_from_s3.md

* Update configuration.md

* Update generating_the_url.md

* Update chained_pipelines.md but chained pipelines section is not finished

* Update serving_files_from_google_cloud_storage.md

* Update new_relic.md

* Update prometheus.md

* Update datadog.md

* Update image_formats_support.md

* Update about_processing_pipeline.md

* Update healthcheck.md

* Update memory_usage_tweaks.md

* Remove GIF/ICO/BMP/HEIF/AVIF support sections from docs/image_formats_support.md

* Minor fixes of the docs

* Update serving_files_from_azure_blob_storage.md

* Fix issue with x and y offset for 're' watermark property

* Fix params description in docs/watermark.md

* Fix Alexander Madyankin GH name

* Special thanks to Travis

* Fix README

Co-authored-by: DarthSim <darthsim@gmail.com>
2022-02-01 15:43:36 +06:00

715 B

Health check

imgproxy comes with a built-in health check HTTP endpoint at /health.

GET /health returns an HTTP Status of 200 OK if the server has been successfully started.

You can use this for readiness/liveness probes when deploying with a container orchestration system such as Kubernetes.

imgproxy health

imgproxy provides an imgproxy health command that makes an HTTP request to the health endpoint based on the IMGPROXY_BIND and IMGPROXY_NETWORK configs. It exits with 0 when the request is successful and with 1 otherwise. The command is handy to use with Docker Compose:

healthcheck:
  test: [ "CMD", "imgproxy", "health" ]
  timeout: 10s
  interval: 10s
  retries: 3