1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
|
# --
# INSTALL description of OTRS
# Copyright (C) 2001-2005 Martin Edenhofer <martin+code@otrs.org>
# --
# $Id: INSTALL,v 1.38 2005/03/27 12:02:53 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)
* LDAPv2 compliant server (OpenLDAP for works fine, however LDAP isn't required)
* some CPAN-Module (DBI, DBD::mysql, Digest::MD5, MIME::Base64 (if Perl < 5.8), Net::DNS, LWP::UserAgent)
for LDAP (Net::LDAP) and for stats (GD, GD::Text, GD::Graph, GD::Graph::lines,
GD::Text::Align)
Installation:
=============
This few steps describe an OTRS installation incl. webserver and database
settings. The OTRS user is "otrs" and the home (root) directory is /opt/otrs
(of course you can choose an other directory or/and OTRS user).
1. Install CPAN Modules (if needed):
---------------------------------
Note: use "bin/otrs.checkModules" to get an overview of all installed and
required cpan modules.
a) Install the RPMs if your distributions provides RPMs for
the required CPAN modules.
b) Install the required modules via CPAN shell (http://www.cpan.org/)
perl -MCPAN -e shell;
...
install Digest::MD5
install Net::DNS
install MIME::Base64 (if Perl < 5.8)
...
if you plan to use an LDAP directory service you should install Net::LDAP
...
install Net::LDAP
...
and maybe the GD stuff (stats support, not required!)
...
install GD
install GD::Text
install GD::Graph
install GD::Graph::lines
install GD::Text::Align
...
2. Create user:
------------
Add user:
---------
$shell: useradd -d /opt/otrs/ -c 'OTRS user' otrs
Add user to webserver group (if the webserver is not running with OTRS user):
-----------------------------------------------------------------------------
$shell: usermod -G nogroup otrs
(SuSE=nogroup, Red Hat=apache)
3. Install tar.gz:
---------------
$shell: cd /opt/
$shell: tar -xzvf otrs-xxxx-xx-xx.tar-gz
4. Demo config files:
------------------
There are several OTRS demo config files in $OTRS_HOME/Kernel/*.dist
and $OTRS_HOME/Kernel/Config/*.dist. Make copies of all demo config files:
cp Kernel/Config.pm.dist Kernel/Config.pm
cd Kernel/Config/
for foo in *.dist; do cp $foo `basename $foo .dist`; done
Or if you are installing OTRS an a Windows system:
copy Kernel/Config.pm.dist Kernel/Config.pm
cd Kernel/Config/
copy *.dist *.
5. Check if all needed modules are installed:
------------------------------------------
$shell:~> perl -cw /opt/otrs/bin/cgi-bin/index.pl
/opt/otrs/bin/cgi-bin/index.pl syntax OK
$shell:~> perl -cw /opt/otrs/bin/PostMaster.pl
/opt/otrs/bin/PostMaster.pl syntax OK
$shell:~>
If you get "syntax OK" it seems to be Ok. Go ahead.
6. Webserver:
----------
[follow README.webserver]
7. File Permissions:
-----------------
Set the file permissions with
"$HOME/bin/SetPermissions.sh <OTRS_HOME> <OTRS_USER> <WEBSERVER_USER> [OTRS_GROUP] [WEB_GROUP]"
e. g.
Webserver with OTRS user: "SetPermissions.sh /opt/otrs otrs otrs"
Webserver with wwwrun user (e. g. SuSE): "SetPermissions.sh /opt/otrs otrs wwwrun"
Webserver with apache user (e. g. Redhat): "SetPermissions.sh /opt/otrs otrs apache apache apache"
8. Database setup:
---------------
If you use MySQL, you can use the Web-Installer (http://yourhost/otrs/installer.pl).
Else follow README.database --> "DB - Setup Example".
9. Config file ($HOME/Kernel/Config.pm):
-------------------------------------
If you used the Web-Installer, you can skip this point. If not,
set some Kernel::Config ($HOME/Kernel/Config.pm) Options (FQDN, SystemID, Ticket::Hook,
Home, ...)
10. First Login:
------------
http://yourhost/otrs/index.pl
User: root@localhost
PW: root
--> goto AdminArea and set some config settings (UserAdd, Queues, ...).
Finished.
11. First Email:
------------
pipe an email directly into $OTRS_HOME/bin/Postmaster.pl
(e. g. 'cat /opt/otrs/doc/test-email-1.box | /opt/otrs/bin/PostMaster.pl').
12. Cronjobs for the OTRS user:
---------------------------
There are several OTRS default cronjobs in $OTRS_HOME/var/cron/*.dist.
Make copies of all of the default cronjobs:
cd var/cron
for foo in *.dist; do cp $foo `basename $foo .dist`; done
Or if you are installing OTRS an a Windows system:
cd var/cron
copy *.dist *.
Use $OTRS_HOME/bin/Cron.sh {start|stop|restart} to start or stop this cronjobs
from $OTRS_HOME/var/cron/* (.dist will be ignored).
>> Note: Install this cronjobs as OTRS user. <<
Notes:
======
Also you should read the OTRS performance tuning chapter on our homepage:
http://doc.otrs.org/cvs/en/html/performance-tuning.html
For installation questions ask otrs@otrs.org (http://lists.otrs.org/).
Have a lot of fun.
Your OTRS Team
(January 2004 Frankfurt/Germany)
EOF
|