home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 April / CMCD0404.ISO / Software / Freeware / Programare / dotproject / modules / ticketsmith / INSTALL < prev    next >
Encoding:
Text File  |  2003-07-16  |  3.0 KB  |  95 lines
  1. Installing gateway.pl for dotProject.  Gateway.pl is a Perl executable
  2. that takes incoming email to a specific mail address and forwards it
  3. to the ticketsmith module.
  4.  
  5. QUICK START:
  6.  
  7. 1. Make sure gateway.pl (which is in the dotproject/includes directory)
  8.    is executable:
  9.  
  10.        chmod a+x gateway.pl
  11.  
  12. 2. Check the first line of gateway.pl and make sure it matches your system,
  13.    on UNIX/Linux systems it should read:
  14.  
  15.        #!/usr/bin/perl -w
  16.  
  17.    or whatever the path to your Perl executable is.
  18.  
  19.    Windows systems need a windows path, which includes a drive letter
  20.    and backslash path separators (as in the supplied file).
  21.  
  22.    The -w is optional and forces perl to report all warnings.
  23.  
  24. 3. Configure your MDA (Mail Delivery Agent) or MTA (Mail Transport Agent)
  25.    to pipe mail for your support mail address to gateway.pl.
  26.  
  27.    Example 1:  Procmail recipe
  28.  
  29.       :0
  30.       * ^TO.*support
  31.       | /path/to/dotproject/includes/gateway.pl /path/to/dotproject/includes/config.php
  32.  
  33.    Example 2:  Using sendmail aliases
  34.  
  35.       support:    "| /path/to/dotproject/includes/gateway.pl /path/to/dotproject/includes/config.php"
  36.  
  37.  
  38. PREREQUISITES:
  39.  
  40. 1.    A working mail system that can pass email to the standard input
  41.     of a program.  Sendmail, procmail, traditional UNIX mail systems
  42.     all are capable of this.  I have no experience of Windows email
  43.     systems and so cannot comment on their abilities.
  44.  
  45. 2.    Mimencode - the command line utility required to extract MIME
  46.     message components.  Only required if you are saving attachments.
  47.  
  48.  
  49. GATEWAY OPTIONS:
  50.  
  51. In the top of gateway.pl you will find several optional flags that can be
  52. set to control the operation of tickets.
  53.  
  54. These options are:
  55.  
  56. $send_email_report
  57.     If set to a non-zero value an email will be sent to the
  58.     $report_to_address with a URL link to the ticket within
  59.     dotproject.  Highly recommended.
  60.  
  61. $send_acknowledge
  62.     If set to a non-zero value an email will be sent to the
  63.     sender of the ticket email, acknowledging the receipt.
  64.  
  65. $save_attachments
  66.     If set to a non-zero value, email attachments will be
  67.     stored as files in the dotProject Files module, under
  68.     project 0.  If set to zero, attachments will be stripped.
  69.  
  70.     If saving attachments, mimencode must be on the system
  71.     and in the execution path.
  72.  
  73. $skip_mime_prefix
  74.     If set to a non-zero value MIME emails with non-mime portions
  75.     will have them removed.  Otherwise non-MIME portions will be
  76.     included as part of the message.
  77.  
  78. $report_to_address
  79.     A partial or full email address of the user who should
  80.     receive notifications of incoming tickets.  If it includes
  81.     an '@' symbol, the entire string should be in single quotes
  82.     and the email address will be used as-is.  If not, the
  83.     dotproject site_domain will be added to the address.
  84.  
  85. $report_from_address
  86.     A partial or full email address of the sender for email
  87.     reports. Same rules as $report_to_address
  88.  
  89.  
  90. $mailprog
  91.     Full pathname of a mail transport agent that accepts -t
  92.     to allow it to take a pre-formatted email and send it
  93.     to the recipient(s) named in the headers.  Typically this
  94.     is sendmail.
  95.