# --
# INSTALL description of OpenTRS
# Copyright (C) 2001-2002 Martin Edenhofer <martin+code@otrs.org>
# --
# $Id: INSTALL,v 1.11 2002/08/04 14:47:39 martin Exp $
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see 
# the enclosed file COPYING for license information (GPL). If you 
# did not receive this file, see http://www.gnu.org/licenses/gpl.txt.
# --

Software requirements?
======================

  On all Perl-Platforms! You need:
    * min. Perl5
    * Database (e. g. MySQL, PostgreSQL)
    * Webpserver (mod_perl isn't required but very nice to have)
    * some CPAN-Module (CGI, MIME::Words, Mail::Internet, MIME::Parser, DBI,
      DBD::mysql, Digest::MD5) and for stats (GD, GD::Text, GD::Graph, 
      GD::Graph::lines, Date::Calc)

Installation:
=============

1. Install CPAN Modules (if needed):
   ---------------------------------
   a) Install the RPMs if your distributions provides RPMs for
      the CPAN modules. 

   b) Install the modules via CPAN (http://www.cpan.org/)
      perl -MCPAN -e shell;
      ...
      install MIME::Words
      install MIME::Parser
      install Digest::MD5
      ...

      and maybe the GD stuff (stats support, not required!)
      ...
      install GD
      install GD::Text
      install GD::Graph
      install GD::Graph::lines
      install Date::Calc
      ...

2. Create user and install tar.gz: 
   -------------------------------
   $shell: useradd -d /opt/OpenTRS/ otrs
   $shell: cd /opt/
   $shell: tar -xzvf otrs-xxxx-xx-xx.tar-gz
   $shell: chown -r /opt/OpenTRS/* otrs
   
3. Database setup:
   ---------------
   [follow README.database --> Setup Example]

4. Webserver:
   ----------
   [follow README.webserver] 

5. Config file ($HOME/Kernel/Config.pm):
   -------------------------------------
   Set some Kernel::Config Options

6. File Permissions:
   -----------------
   Set the file permissions with 
   "$HOME/bin/SetPermissions.sh  <OTRS_HOME> <OTRS_USER> <WEBSERVER_USER>"
   e. g. "SetPermissions.sh /opt/OpenTRS otrs wwwrun".

7. First Login:
   ------------
   http://yourhost/otrs/index.pl
   User: root@localhost
   PW: root

   --> goto AdminArea and set some config settings (UserAdd, Queues, ...).

   Finished.

8. First Email:
   ------------
   use the procmailrc of the OpenTRS-User --> /opt/OpenTRS/.procmailrc

   --> send emails to the otrs user (e. g. otrs@localhost)

   or pipe an email directly into $OpenTRS_HOME/bin/Postmaster.pl
    (e. g. 'cat /opt/OpenTRS/doc/test-email-1.box | /opt/OpenTRS/bin/PostMaster.pl').

Remark: For installation questions ask otrs@otrs.org (http://lists.otrs.org/).

Have a lot of fun.

 Martin Edenhofer 

(April 2002 Frankfurt/Germany)

EOF
