source: emailtotracscript/trunk/INSTALL @ 35

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

EmailtoTracScript?:

email2trac:

  • we can now set the default poth for the config file with configure for email2trac.py
  • Added svn keywords for all the files
  • Updated the install doc
  • Property svn:mime-type set to text/x-trac-wiki
File size: 2.8 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
16 reply_address: 1           # OPTIONAL, if set then fill in ticket CC field
17 umask: 022                 # OPTIONAL, Use this umask for saving attachments
18 mailto_link: 1             # OPTIONAL, if set then [mailto:<CC>] in description
19 email_header: 1            # OPTIONAL, if set then show TO/CC fields in description
20 trac_version: 0.8          # OPTIONAL, if set use this as trac version (D: 0.9)
21
[20]22 [bas]                     # OPTIONAL project declaration, also set
23                           # project option, use -p|--project
24 project: /data/trac/bas   #
[19]25 spam_level: 2             # Override DEFAULT spam_level, can also be
26                           # done for other options
[16]27}}}
[5]28
[16]29== Installation and Configuration ==
[5]30
[16]31First build, install email2trac :
[5]32
[24]33  * ./configure (see --help)
34    {{{
35    default values for:
36       prefix=/usr/local        --> --prefix=<path>
37       exec_prefix=$prefix/bin  --> --exec_prefix=<path>
38       sysconfdir=$prefix/etc   --> --sysconfdir=<path>
39       MTA_USER=nobody          --> --with-mta_user=<name>
40       TRAC_USER=www-data       --> --with-trac_user=<name>
41    }}}
[16]42  * make
43  * make install
[24]44  * First install copy emailtrac.conf to $sysconfdir
[5]45
[19]46 After installation, edit email2trac.conf for your site. Most important
47 parameter is project, see above
[9]48
[16]49== Usage ==
50
[19]51It depends on your MTA how the setup is. For Sendmail and Postfix, the p
52rocedure is the same :
53 * Edit your alias definition file (default : /etc/aliases for Postfix,
54   /etc/mail/aliases for Sendmail) and add one line per project/component you
55   want to allow ticket submission from email to. For each alias, you can
56   specify option --project. This option selects a configuration stanza in the
57   config file and ''--component'' to specify a component other than the
58   default component for the project. Line must have the following format :
[16]59{{{
60     tracproj: |/usr/sbin/run_email2trac [--project=<project_name>] [--component=<project_component>]
61}}}
62
63  * Update your alias database with command ''newaliases''
[19]64  * Test with a command like :
[16]65{{{
66     mail tracproj < test7.eml
67}}}
Note: See TracBrowser for help on using the repository browser.