Changeset 16


Ignore:
Timestamp:
01/07/06 15:49:42 (16 years ago)
Author:
jouvin
Message:

EmailtoTracScript?:

Define ChangeLog? mime-type (and rename to ChangeLog?)

Location:
emailtotracscript/trunk
Files:
1 edited
1 moved

Legend:

Unmodified
Added
Removed
  • emailtotracscript/trunk/ChangeLog

    • Property svn:mime-type set to text/x-trac-wiki
  • emailtotracscript/trunk/INSTALL

    r9 r16  
     1= Installation and Configuration of email2trac =
     2
    13The email2trac package contains the following utilities:
    2  - email2trac.py:
    3     Converts an email to ticket. Reads a config file email2trac.conf
    4  - run_email2trac.c:
    5     Suid program that changes the MTA-user to the TRAC-user so that we can
    6     save attachments
    7  - delete_spam.py:
    8     A small program that deletes the SPAM tickets from the database
    9  - email2trac.conf:
    10     Is read by email2trac.py to set the various options. This are the options:
    11     [DEFAULT]               # REQUIRED
    12     project: /data/trac/bas # REQUIRED
    13     debug: 1                # OPTIONAL, if set print some DEBUG info
    14     spam_level: 4           # OPTIONAL, if set check for SPAM mail
    15     reply_address: 1        # OPTIONAL, if set then fill in ticket CC field
    16     umask: 022              # OPTIONAL, Use this umask for saving attachments
    17     mailto_link: 1          # OPTIONAL, if set then [mailto:<CC>] in description
    18     email_header: 1         # OPTIONAL, if set then show TO/CC fields in description
    19     trac_version: 0.8       # OPTIONAL, if set use this as trac version
     4 * '''email2trac.py''' : converts an email to ticket. Reads a config file email2trac.conf
     5 * '''run_email2trac.c''' : suid program that changes the MTA-user to the TRAC-user so that we can save attachments
     6 * '''delete_spam.py''' : small program that deletes the SPAM tickets from the database
     7 * '''email2trac.conf''' : read by email2trac.py to set the various options. This are the options:
     8{{{
     9    [DEFAULT]                   # REQUIRED
     10    project_root: /data/trac    # REQUIRED if project: doesn't specify a project
     11                                # full path, else OPTIONAL
     12    project: bas                # OPTIONAL if project_root: present,
     13                                # else REQUIRED and MUST specify a project full path
     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}}}
    2022
     23== Installation and Configuration ==
    2124
    22 SETUP
    23 =====
     25First build, install email2trac :
    2426
    25 It depends on your MTA how the setup is. Below is an example of the SARA setup
    26 that uses postfix as our MTA. 
    27   - Edit Makefile, adjust the variables
    28   - make
    29   - make install
    30   - Copy email2trac.conf to /etc  (default location for email2trac.py)
    31     If different location use the "-f <config file> or --file=<config file>" to run_email2trac
     27  * Edit Makefile, adjust the variables (in particular INSTALL_DIR, MTA_USER and TRAC_USER)
     28  * make
     29  * make install
     30  * Define a symlink /etc/email2trac.conf referencing $INSTALL_DIR/email2trac.conf
    3231
    33   - vi /etc/aliases
    34      bas: |/usr/sbin/run_email2trac [-f <config file>| --file=<config file>]
     32 After installatin, edit email2trac.conf for your site. Most important parameters are project_root: and project:. project: defines a default project, when project_root: is specified.
    3533
    36   - newaliases
    37   - Test
    38      mail bas < test7.eml
     34== Usage ==
     35
     36It depends on your MTA how the setup is. For Sendmail and Postfix, the procedure is the same :
     37
     38 * 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 to specify a project other than the default configured inside the configuration file (project must be located below ''project_root'') and option ''--component'' to specify a component other than the default component for the project. Line must have the following format :
     39{{{
     40     tracproj: |/usr/sbin/run_email2trac [--project=<project_name>] [--component=<project_component>]
     41}}}
     42
     43  * Update your alias database with command ''newaliases''
     44  *  Test with a command like :
     45{{{
     46     mail tracproj < test7.eml
     47}}}
Note: See TracChangeset for help on using the changeset viewer.