From 5618df78f8e89799b58d821f0f65d1882565d0e0 Mon Sep 17 00:00:00 2001 From: alanmcruickshank Date: Mon, 20 Jun 2016 17:24:49 +0100 Subject: [PATCH] Added documentation of the health check endpoint (#644) --- docs/installation.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/installation.rst b/docs/installation.rst index c972f96371..c62befc3b0 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -82,6 +82,15 @@ the credential you entered while creating the admin account, and navigate to your datasources for Caravel to be aware of, and they should show up in `Menu -> Datasources`, from where you can start playing with your data! +Configuration behind a load balancer +------------------------------------ + +If you are running caravel behind a load balancer or reverse proxy (e.g. NGINX +or ELB on AWS), you may need to utilise a healthcheck endpoint so that your +load balancer knows if your caravel instance is running. This is provided +at ``/health`` which will return a 200 response containing "OK" if the +webserver is running. + Configuration -------------