Added automatic actions based on a daily event

12 files changed, 78 insertions, 22 deletions

diff --git a/doc/analytics.markdown b/doc/analytics.markdown
index 13657b56..d72fc383 100644
--- a/doc/analytics.markdown
+++ b/doc/analytics.markdown
@@ -62,9 +62,4 @@ This chart show the average lead and cycle time for the last 1000 tasks over tim
 
 Those metrics are calculated and recorded every day for the whole project.
 
-Don't forget to run the daily job for statistics calculation
--------------------------------------------------------
-
-To generate accurate analytic data, you should run the daily cronjob **project daily statistics**.
-
-[Read the documentation of Kanboard CLI](cli.markdown)
+Note: Don't forget to run the [daily cronjob](cronjob.markdown) to have accurate statistics.
diff --git a/doc/centos-installation.markdown b/doc/centos-installation.markdown
index d0fd6a00..576119b4 100644
--- a/doc/centos-installation.markdown
+++ b/doc/centos-installation.markdown
@@ -1,6 +1,8 @@
 Centos Installation
 ===================
 
+Note: Some features of Kanboard require that you run [a daily background job](cronjob.markdown).
+
 Centos 7
 --------
 
diff --git a/doc/cli.markdown b/doc/cli.markdown
index bcb478dd..9334d84b 100644
--- a/doc/cli.markdown
+++ b/doc/cli.markdown
@@ -4,7 +4,7 @@ Command Line Interface
 Kanboard provides a simple command line interface that can be used from any Unix terminal.
 This tool can be used only on the local machine.
 
-This feature is useful to run commands outside the web server process by example running a huge report.
+This feature is useful to run commands outside of the web server processes.
 
 Usage
 -----
@@ -28,6 +28,7 @@ Options:
   -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
 
 Available commands:
+  cronjob                            Execute daily cronjob
   help                               Displays help for a command
   list                               Lists commands
  export
@@ -42,6 +43,8 @@ Available commands:
   notification:overdue-tasks         Send notifications for overdue tasks
  projects
   projects:daily-stats               Calculate daily statistics for all projects
+ trigger
+  trigger:tasks                      Trigger scheduler event for all tasks
 ```
 
 Available commands
@@ -116,7 +119,7 @@ Emails will be sent to all users with notifications enabled.
 You can also display the overdue tasks with the flag `--show`:
 
 ```bash
-$ ./kanboard notification:overdue-tasks --show
+./kanboard notification:overdue-tasks --show
 +-----+---------+------------+------------+--------------+----------+
 | Id  | Title   | Due date   | Project Id | Project name | Assignee |
 +-----+---------+------------+------------+--------------+----------+
@@ -125,20 +128,22 @@ $ ./kanboard notification:overdue-tasks --show
 +-----+---------+------------+------------+--------------+----------+
 ```
 
-Cronjob example:
-
-```bash
-# Everyday at 8am we check for due tasks
-0 8 * * *  cd /path/to/kanboard && ./kanboard notification:overdue-tasks >/dev/null 2>&1
-```
-
 ### Run daily project stats calculation
 
-You can add a background task to calculate the project statistics every day:
+This command calculate the statistics of each project:
 
 ```bash
-$ ./kanboard projects:daily-stats
+./kanboard projects:daily-stats
 Run calculation for Project #0
 Run calculation for Project #1
 Run calculation for Project #10
 ```
+
+### Trigger for tasks
+
+This command send a "daily cronjob event" to all open tasks of each project.
+
+```bash
+./kanboard trigger:tasks
+Trigger task event: project_id=2, nb_tasks=1
+```
diff --git a/doc/cronjob.markdown b/doc/cronjob.markdown
new file mode 100644
index 00000000..32f12888
--- /dev/null
+++ b/doc/cronjob.markdown
@@ -0,0 +1,32 @@
+Background Job Scheduling
+=========================
+
+To work properly, Kanboard requires that a background job run on a daily basis.
+Usually on Unix platforms, this process is done by `cron`.
+
+This background job is necessary for these features:
+
+- Reports and analytics (calculate daily stats of each projects)
+- Send overdue task notifications
+- Execute automatic actions connected to the event "Daily background job for tasks"
+
+Configuration on Unix and Linux platforms
+-----------------------------------------
+
+There are multiple ways to define a cronjob on Unix/Linux operating systems, this example is for Ubuntu 14.04.
+The procedure is similar to other systems.
+
+Edit the crontab of your web server user:
+
+```bash
+sudo crontab -u www-data -e
+```
+
+Example to execute the daily cronjob at 8am:
+
+```bash
+0 8 * * * cd /path/to/kanboard && ./kanboard cronjob >/dev/null 2>&1
+```
+
+Note: the cronjob process must have write access to the database in case you are using Sqlite.
+Usually, running the cronjob under the web server user is enough.
diff --git a/doc/debian-installation.markdown b/doc/debian-installation.markdown
index 147fe452..ec956049 100644
--- a/doc/debian-installation.markdown
+++ b/doc/debian-installation.markdown
@@ -1,6 +1,8 @@
 How to install Kanboard on Debian?
 ==================================
 
+Note: Some features of Kanboard require that you run [a daily background job](cronjob.markdown).
+
 Debian 8 (Jessie)
 -----------------
 
diff --git a/doc/freebsd-installation.markdown b/doc/freebsd-installation.markdown
index 84b35ad8..7b36dff1 100644
--- a/doc/freebsd-installation.markdown
+++ b/doc/freebsd-installation.markdown
@@ -55,7 +55,7 @@ Generally 3 elements have to be installed:
 Fetch and extract ports...
 
 ```bash
-$ portsnap fetch 
+$ portsnap fetch
 $ portsnap extract
 ```
 
@@ -122,6 +122,7 @@ there is no need to install it manually.
 Please note
 -----------
 
-Port is being hosted on [bitbucket](https://bitbucket.org/if0/freebsd-kanboard/). Feel free to comment,
+- Port is being hosted on [bitbucket](https://bitbucket.org/if0/freebsd-kanboard/). Feel free to comment,
 fork and suggest updates!
- 
\ No newline at end of file
+- Some features of Kanboard require that you run [a daily background job](cronjob.markdown).
+
diff --git a/doc/heroku.markdown b/doc/heroku.markdown
index 56d79bc9..f145f70e 100644
--- a/doc/heroku.markdown
+++ b/doc/heroku.markdown
@@ -35,5 +35,5 @@ heroku open
 Limitations
 -----------
 
-The storage of Heroku is ephemeral, that means uploaded files through Kanboard are not persistent after a reboot.
-We may want to install a plugin to store your files in a cloud storage provider like [Amazon S3](https://github.com/kanboard/plugin-s3).
+- The storage of Heroku is ephemeral, that means uploaded files through Kanboard are not persistent after a reboot. You may want to install a plugin to store your files in a cloud storage provider like [Amazon S3](https://github.com/kanboard/plugin-s3).
+- Some features of Kanboard require that you run [a daily background job](cronjob.markdown).
diff --git a/doc/index.markdown b/doc/index.markdown
index 1e95fe06..7603117b 100644
--- a/doc/index.markdown
+++ b/doc/index.markdown
@@ -103,6 +103,7 @@ Technical details
 ### Configuration
 
 - [Config file](config.markdown)
+- [Background tasks](cronjob.markdown)
 - [Email configuration](email-configuration.markdown)
 - [URL rewriting](nice-urls.markdown)
 
diff --git a/doc/installation.markdown b/doc/installation.markdown
index b208be8a..dd4283f8 100644
--- a/doc/installation.markdown
+++ b/doc/installation.markdown
@@ -39,3 +39,8 @@ Security
 
 - Don't forget to change the default user/password
 - Don't allow everybody to access to the directory `data` from the URL. There is already a `.htaccess` for Apache but nothing for Nginx.
+
+Notes
+-----
+
+- Some features of Kanboard require that you run [a daily background job](cronjob.markdown)
diff --git a/doc/ubuntu-installation.markdown b/doc/ubuntu-installation.markdown
index cec3ebba..ab4dfe7c 100644
--- a/doc/ubuntu-installation.markdown
+++ b/doc/ubuntu-installation.markdown
@@ -26,3 +26,5 @@ sudo unzip kanboard-latest.zip
 sudo chown -R www-data:www-data kanboard/data
 sudo rm kanboard-latest.zip
 ```
+
+Some features of Kanboard require that you run [a daily background job](cronjob.markdown).
diff --git a/doc/windows-apache-installation.markdown b/doc/windows-apache-installation.markdown
index 2c8f74e1..27b6812e 100644
--- a/doc/windows-apache-installation.markdown
+++ b/doc/windows-apache-installation.markdown
@@ -123,3 +123,8 @@ Tested configuration
 --------------------
 
 - Windows 2008 R2 / Apache 2.4.12 / PHP 5.6.8
+
+Notes
+-----
+
+- Some features of Kanboard require that you run [a daily background job](cronjob.markdown).
diff --git a/doc/windows-iis-installation.markdown b/doc/windows-iis-installation.markdown
index 6206db21..bd4607de 100644
--- a/doc/windows-iis-installation.markdown
+++ b/doc/windows-iis-installation.markdown
@@ -65,3 +65,9 @@ Tested configurations
 
 - Windows 2008 R2 Standard Edition / IIS 7.5 / PHP 5.5.16
 - Windows 2012 Standard Edition / IIS 8.5 / PHP 5.3.29
+
+Notes
+-----
+
+- Some features of Kanboard require that you run [a daily background job](cronjob.markdown).
+