diff --git a/README b/README new file mode 100644 index 0000000..791bdbf --- /dev/null +++ b/README @@ -0,0 +1,27 @@ +mail2redmine +============ + +mail2redmine converts incoming email from Exim to Redmine tracker tickets by +using mail subject and body as ticket title and description respectively. + +Ticket owner is detected from sender's address if a corresponding account +exists on Redmine. The email is sent to a fallback address if account doesn't +exist. + +Email attachment are joined to the ticket. + +Installation and configuration +============================== + +Copy both scripts ``mail2redmine.py`` and ``eo-redmine-mailfilter.sh`` under +`/usr/local/bin`. + +Configure your exim server to redirect emails to ``eo-redmine-mailfilter.sh`` +script: + +` +^support-[a-z-]*: "|/usr/local/bin/eo-redmine-mailfilter.sh" +` + +Put an admin's account API key in ``/etc/redmine-key`` file. +