summaryrefslogtreecommitdiff
path: root/doc/mailgun.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/mailgun.markdown
parentef087f5e22df1a0d97babef26aaf9b8960ee6d5d (diff)
Include documentation in the application
Diffstat (limited to 'doc/mailgun.markdown')
-rw-r--r--doc/mailgun.markdown28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/mailgun.markdown b/doc/mailgun.markdown
new file mode 100644
index 00000000..6465903a
--- /dev/null
+++ b/doc/mailgun.markdown
@@ -0,0 +1,28 @@
+Mailgun
+=======
+
+You can use the service [Mailgun](http://www.mailgun.com/) to create tasks directly by email.
+
+This integration works with the inbound email service of Mailgun (routes).
+Kanboard use a webhook to handle incoming emails.
+
+The [incoming email workflow is described here](create-tasks-by-email.markdown).
+
+Mailgun configuration
+---------------------
+
+Create a new route in the web interface or via the API ([official documentation](https://documentation.mailgun.com/user_manual.html#routes)), here an example:
+
+```
+match_recipient("^kanboard\+(.*)@mydomain.tld$")
+forward("https://mykanboard/?controller=webhook&action=mailgun&token=mytoken")
+```
+
+The Kanboard webhook url is displayed in **Settings > Integrations > Mailgun**
+
+Kanboard configuration
+----------------------
+
+1. Be sure that your users have an email address in their profiles
+2. Assign a project identifier to the desired projects: **Project settings > Edit**
+3. Try to send an email to your project