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