| 1 | = Installation and Configuration of email2trac = |
|---|
| 2 | |
|---|
| 3 | The email2trac package contains the following utilities: |
|---|
| 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 | }}} |
|---|
| 22 | |
|---|
| 23 | == Installation and Configuration == |
|---|
| 24 | |
|---|
| 25 | First build, install email2trac : |
|---|
| 26 | |
|---|
| 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 |
|---|
| 31 | |
|---|
| 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. |
|---|
| 33 | |
|---|
| 34 | == Usage == |
|---|
| 35 | |
|---|
| 36 | It 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 | }}} |
|---|
