source: emailtotracscript/trunk/INSTALL @ 74

Last change on this file since 74 was 74, checked in by bas, 18 years ago

EmailtoTracScript?:

email2trac.py.in:

  • Added options for mailto_cc and ticket_update
  • Ticket updates are now working

INSTALL:

  • Adjusted the docs for new options
  • Property svn:mime-type set to text/x-trac-wiki
File size: 3.1 KB
RevLine 
[16]1= Installation and Configuration of email2trac =
2
[5]3The email2trac package contains the following utilities:
[19]4 email2trac.py   : converts an email to ticket. Reads a config file
5                   email2trac.conf
6 run_email2trac.c: suid program that changes the MTA-user to the TRAC-user so
7                   that we can save attachments
8 delete_spam.py  : small program that deletes the SPAM tickets from the database
9 email2trac.conf : read by email2trac.py to set the various options. This are
10                   the options:
[16]11{{{
[19]12 [DEFAULT]                  # REQUIRED
13 project: /data/trac/jouvin # REQUIRED
14 debug: 1                   # OPTIONAL, if set print some DEBUG info
15 spam_level: 4              # OPTIONAL, if set check for SPAM mail
[47]16 reply_address: 1           # OBSOLETE, see trac.ini notification section
17 reply_all: 1               # OPTIONAL, if set then put all CC-addresses in ticket CC-field
[19]18 umask: 022                 # OPTIONAL, Use this umask for saving attachments
19 mailto_link: 1             # OPTIONAL, if set then [mailto:<CC>] in description
[74]20 mailto_cc: basv@sara.nl    # OPTIONAL, Use ths address as CC in mailto line
21 ticket_update: 1           # OPTIONAL, if set then check if this is an update for a ticket
[19]22 email_header: 1            # OPTIONAL, if set then show TO/CC fields in description
23 trac_version: 0.8          # OPTIONAL, if set use this as trac version (D: 0.9)
24
[20]25 [bas]                     # OPTIONAL project declaration, also set
26                           # project option, use -p|--project
27 project: /data/trac/bas   #
[19]28 spam_level: 2             # Override DEFAULT spam_level, can also be
29                           # done for other options
[16]30}}}
[5]31
[16]32== Installation and Configuration ==
[5]33
[16]34First build, install email2trac :
[5]35
[51]36option 1:
37  * ./configure (see --help)
[24]38    {{{
39    default values for:
40       prefix=/usr/local        --> --prefix=<path>
41       exec_prefix=$prefix/bin  --> --exec_prefix=<path>
42       sysconfdir=$prefix/etc   --> --sysconfdir=<path>
43       MTA_USER=nobody          --> --with-mta_user=<name>
44       TRAC_USER=www-data       --> --with-trac_user=<name>
45    }}}
[16]46  * make
47  * make install
[24]48  * First install copy emailtrac.conf to $sysconfdir
[5]49
[51]50option 2:
51  * debian/rules binary
52  * First install copy emailtrac.conf to /etc
[9]53
[51]54After installation, edit email2trac.conf for your site. Most important
55parameter is project, see above
56
[16]57== Usage ==
58
[19]59It depends on your MTA how the setup is. For Sendmail and Postfix, the p
60rocedure is the same :
61 * Edit your alias definition file (default : /etc/aliases for Postfix,
62   /etc/mail/aliases for Sendmail) and add one line per project/component you
63   want to allow ticket submission from email to. For each alias, you can
64   specify option --project. This option selects a configuration stanza in the
65   config file and ''--component'' to specify a component other than the
66   default component for the project. Line must have the following format :
[16]67{{{
68     tracproj: |/usr/sbin/run_email2trac [--project=<project_name>] [--component=<project_component>]
69}}}
70
71  * Update your alias database with command ''newaliases''
[19]72  * Test with a command like :
[16]73{{{
[56]74     mail tracproj
[16]75}}}
Note: See TracBrowser for help on using the repository browser.