diff --git a/modules/cron/docs/cron.md b/modules/cron/docs/cron.md index f6b159c6ed617d27220e57200fcff41c0b5d101a..ac65bf4892d7c1e5404fae01d7f861ffdda8333c 100644 --- a/modules/cron/docs/cron.md +++ b/modules/cron/docs/cron.md @@ -1,13 +1,6 @@ Cron ============================= -<!-- - This file is written in Markdown syntax. - For more information about how to use the Markdown syntax, read here: - http://daringfireball.net/projects/markdown/syntax ---> - - [TOC] Introduction @@ -17,6 +10,13 @@ The cron module allows you to do tasks regularly, by setting up a cron job that calls a hook in SimpleSAMLphp. This will invoke `hooks/hook_cron.php` in any enabled modules +Modules, like e.g. the metarefresh module, that want to invoke tasks +on set times, can register cron hooks for use by this module. You in turn +configure your system's `cron` or other time based execution functionality +to periodically trigger this module's endpoint, so all registered hooks +will be executed at that time. This module also takes care of reporting +back the result and provides an interface in SimpleSAMLphp's admin +panel to trigger jobs manually. Preparations ------------