Skip to content

Commit

Permalink
Added documentation of the health check endpoint (#644)
Browse files Browse the repository at this point in the history
  • Loading branch information
alanmcruickshank authored and mistercrunch committed Jun 20, 2016
1 parent 668ede1 commit 5618df7
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------
Expand Down

0 comments on commit 5618df7

Please sign in to comment.