summaryrefslogtreecommitdiff
path: root/doc/notifications.markdown
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
committerFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
commit6c711f696f73bc59813f6834ec241aef3b626cbd (patch)
treeded4f0e8c7f8c672414ff3f2f84eac0f6d9073e5 /doc/notifications.markdown
parentef087f5e22df1a0d97babef26aaf9b8960ee6d5d (diff)
Include documentation in the application
Diffstat (limited to 'doc/notifications.markdown')
-rw-r--r--doc/notifications.markdown30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/notifications.markdown b/doc/notifications.markdown
new file mode 100644
index 00000000..f42c66cb
--- /dev/null
+++ b/doc/notifications.markdown
@@ -0,0 +1,30 @@
+Notifications
+=============
+
+Kanboard is able to send notifications through several channels:
+
+- Email
+- Jabber/XMPP
+- Hipchat
+- Slack
+
+Actually, Jabber/Hipchat/Slack notifications are sent to a room or group channel because they are configured at the project level.
+However, email notifications are sent to an individual.
+
+User notifications
+------------------
+
+Each user must enable the notifications in their profile: **User Profile > Email notifications**. It's disabled by default.
+
+You need of course a valid email address in you profile and the application must be configured to send emails.
+
+![Notifications](http://kanboard.net/screenshots/documentation/notifications.png)
+
+For each project your are member, you can choose to receive notifications for:
+
+- All tasks
+- Only for tasks assigned to you
+- Only for tasks created by you
+- Only for tasks created by you and assigned to you
+
+You can also select only some projects, by default it's all projects where you are member.