source:
emailtotracscript/trunk/INSTALL
@
81
Last change on this file since 81 was 81, checked in by bas, 18 years ago | |
---|---|
|
|
File size: 3.6 KB |
Installation and Configuration of email2trac
The email2trac package contains the following utilities:
email2trac.py : converts an email to ticket. Reads a config file
email2trac.conf
run_email2trac.c: suid program that changes the MTA-user to the TRAC-user so
that we can save attachments
delete_spam.py : small program that deletes the SPAM tickets from the database email2trac.conf : read by email2trac.py to set the various options. This are
the options:
[DEFAULT] # REQUIRED project: /data/trac/jouvin # REQUIRED debug: 1 # OPTIONAL, if set print some DEBUG info spam_level: 4 # OPTIONAL, if set check for SPAM mail reply_address: 1 # OBSOLETE, see trac.ini notification section reply_all: 1 # OPTIONAL, if set then put all CC-addresses in ticket CC-field umask: 022 # OPTIONAL, Use this umask for saving attachments mailto_link: 1 # OPTIONAL, if set then [mailto:<CC>] in description mailto_cc: ticket@test.nl # OPTIONAL, Use ths address as CC in mailto line ticket_update: 1 # OPTIONAL, if set then check if this is an update for a ticket email_header: 1 # OPTIONAL, if set then show TO/CC fields in description trac_version: 0.8 # OPTIONAL, if set use this as trac version (D: 0.9) [bas] # OPTIONAL project declaration, also set # project option, use -p|--project project: /data/trac/bas # spam_level: 2 # Override DEFAULT spam_level, can also be # done for other options
Installation and Configuration
First build, install email2trac :
option 1:
- ./configure (see --help)
default values for: prefix=/usr/local --> --prefix=<path> exec_prefix=$prefix/bin --> --exec_prefix=<path> sysconfdir=$prefix/etc --> --sysconfdir=<path> MTA_USER=nobody --> --with-mta_user=<name> TRAC_USER=www-data --> --with-trac_user=<name>
- make
- make install
- First install copy emailtrac.conf to $sysconfdir
option 2:
- debian/rules binary
- First install copy emailtrac.conf to /etc
After installation, edit email2trac.conf for your site. Most important parameter is project, see above
If you have enabled 'ticket_update' in email2trac.conf then you have to choose one of this options to make it work:
1 - Configure trac notification, eg:
- (ticket address: ticket@…) [notification] smtp_enabled = true smtp_always_cc = test@… smtp_server = localhost smtp_from = ticket@… always_notify_reporter = true
2 - Use the mailto_cc in email2trac.conf if you want to sent
an email to the user and the trac ticket email address.
Usage
It depends on your MTA how the setup is. For Sendmail and Postfix, the p rocedure is the same :
- Edit your alias definition file (default : /etc/aliases for Postfix,
/etc/mail/aliases for Sendmail) and add one line per project/component you
want to allow ticket submission from email to. For each alias, you can
specify option --project. This option selects a configuration stanza in the
config file and --component to specify a component other than the
default component for the project. Line must have the following format :
tracproj: |/usr/sbin/run_email2trac [--project=<project_name>] [--component=<project_component>]
- Update your alias database with command newaliases
- Test with a command like :
mail tracproj