From 80d2bf9e8f842421289820162e751dc07d6aad04 Mon Sep 17 00:00:00 2001 From: Trevor Turk Date: Thu, 3 Mar 2016 10:42:54 -0600 Subject: [PATCH] Checks doc: add a header before getting into the custom checks explanation --- docs/checks-examples.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/checks-examples.md b/docs/checks-examples.md index 6c65bc87c..510cb100e 100644 --- a/docs/checks-examples.md +++ b/docs/checks-examples.md @@ -22,6 +22,8 @@ dokku config:set DOKKU_WAIT_TO_RETIRE=120 > Note that during this time, multiple containers may be running on your server, which can be an issue for memory-hungry applications on memory-constrained servers. +## Checks + If your application needs a longer period to boot up - perhaps to load data into memory, or because of slow boot time - you may also use dokku's `checks` functionality to more precisely check whether an application can serve traffic or not. To specify checks, add a `CHECKS` file to the root of your project directory. This is a text file with one line per check. Empty lines and lines starting with `#` are ignored.