Bug#343283: roundup: suggested addition to README.Debian wrt. mail gateway configuration with Exim

[Faheem Mitha <faheem@email.unc.edu>]

Package: roundup
Version: 0.8.2-1
Severity: wishlist

Hi,

In the Roundup installation documentation
(http://roundup.sourceforge.net/doc-0.8/installation.html#configure-an-email-interface),
it says

*******************************************************************
As a mail alias pipe process

Set up a mail alias called "issue_tracker" as (include the quote marks): 
"|/usr/bin/python /usr/local/bin/roundup-mailgw <tracker_home>"
*******************************************************************

However, the Debian Exim4 packages don't allow pipes in alias files by
default, and I propose using a custom router & transport to accomplish
delivery to roundup-mailgw as per the recommendations of the Debian
Exim maintainers.

Please consider appending this information to README.Debian, along
with the other Debian-specific configuration information.

@@@@@@@@@@@@@@@@ BEGIN PROPOSED ADDITION TO README.DEBIAN @@@@@@@@@@@@

The following configuration files for Exim 4 implement a custom router
& transport to accomplish mail delivery to roundup-mailgw as per the
recommendations of the Debian Exim maintainers. 

This configuration replaces the instructions in the Roundup
installation documentation
(http://roundup.sourceforge.net/doc-0.8/installation.html#configure-an-email-interface),
for configuring the mail gateway, which says

*******************************************************************
As a mail alias pipe process

Set up a mail alias called "issue_tracker" as (include the quote marks): 
"|/usr/bin/python /usr/local/bin/roundup-mailgw <tracker_home>"
*******************************************************************

Note that the Debian Exim4 packages don't allow pipes in alias files
by default, so this method will not work with the default
configuration. See the discussion in
/usr/share/doc/exim4-config/README.system_aliases.

The following configuration has been tested on Debian Sarge with Exim4.

The following three config files, when dropped into
/etc/exim4/conf.d/, should do what it necessary. Note that as per
directions in the Debian Exim4 README.Debian, the monolithic file
(unsplit configuration) /etc/exim4/exim4.conf.template can be rebuilt
from the conf.d files by running 'update-exim4.conf.template -r'.

Note that this will overwrite any local changes to
update-exim4.conf.template.

This configuration is largely due to Marc Haber, one of the Debian
Exim maintainers, but has been modified by me.

This config makes a few assumptions:

1) That the mail address corresponding to the tracker instance has the
same name as the directory of the tracker instance, ie. the mail
address corresponding to a Roundup instance called
/var/lib/roundup/trackers/mytracker is mytracker@...

2) That (at least) all the db subdirectories of all the tracker
instances (ie. /var/lib/roundup/trackers/*/db) are owned by the same
user, in this case, 'roundup'.

3) That if the schema.py file exists, then the tracker is 'ready to
go'. I'm not sure if it would be better to use the config.ini file.

However, it has the advantage that modulo these assumptions no further 
configuration will need to be made when new tracker instances are added.

************************************************************************
/etc/exim4/conf.d/main/010_roundup_macros
************************************************************************
# Home dir for your Roundup installation
ROUNDUP_HOME=/var/lib/roundup/trackers

# User and group for Roundup.
ROUNDUP_USER=roundup
ROUNDUP_GROUP=roundup
************************************************************************
/etc/exim4/conf.d/router/050_roundup
************************************************************************
roundup_router:
    driver = accept
    # The config file config.ini seems like a more natural choice, but the
    # file config.py was replaced by config.ini in 0.8, and schema.py needs
    # to be present too.
    require_files = /usr/bin/roundup-mailgw:ROUNDUP_HOME/$local_part/schema.py
    transport = roundup_transport
************************************************************************
/etc/exim4/conf.d/transport/050_roundup
************************************************************************
roundup_transport:
    driver = pipe
    command = /usr/bin/python /usr/bin/roundup-mailgw ROUNDUP_HOME/$local_part/
    current_directory = ROUNDUP_HOME
    home_directory = ROUNDUP_HOME
    user = ROUNDUP_USER
    group = ROUNDUP_GROUP
************************************************************************

@@@@@@@@@@@@@@@@ END PROPOSED ADDITION TO README.DEBIAN @@@@@@@@@@@@@@@@@@@@

If you have followup questions, I suggest you talk to (in addition to
myself), the people on
http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users, who
certainly know much more about all this stuff than I do.

Thanks.                                                          Faheem.

-- System Information:
Debian Release: 3.1
  APT prefers stable
  APT policy: (500, 'stable'), (50, 'unstable'), (50, 'testing')
Architecture: amd64 (x86_64)
Shell:  /bin/sh linked to /bin/bash
Kernel: Linux 2.6.12-1-amd64-k8-smp
Locale: LANG=en_US, LC_CTYPE=en_US (charmap=ISO-8859-1)

Versions of packages roundup depends on:
ii  python                        2.3.5-2    An interactive high-level object-o

roundup recommends no packages.

-- no debconf information