Skip to content
Newer
Older
100644 345 lines (226 sloc) 11.1 KB
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
1 =============================
2 Installation Guide for Installing Koha on Debian Etch with MySQL 5
3 =============================
4
5 Copyright (C) 2007, LibLime
6
7 Maintainer: Joshua Ferraro (jmf AT liblime DOT com)
dcb3858 Several important commits:
Joshua Ferraro authored
8 Feedback/bug reports: jmf AT liblime DOT com
844f1fa updates to some of the finer points of the install process on Etch
Joshua Ferraro authored
9 This document last modified: 29 December 2007
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
10
11 Installation Instructions
12 =============================
13
14 All commands can be performed as a system user with sudo privileges,
77c6fcc fixes to README.debian
Joshua Ferraro authored
15 as indicated or by running the command directly as root.
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
16
77c6fcc fixes to README.debian
Joshua Ferraro authored
17 Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
18 This step is VERY IMPORTANT for a UNICODE compliant system. Please
19 read over the following document carefully:
20
21 http://wiki.koha.org/doku.php?id=encodingscratchpad
22
23 1. Prepare System and Install Dependencies
24
25 1.1 Install Debian Etch via Businesscard CD
26
b74320e @fredericd Some tweaks for Debian Etch install procedure
fredericd authored
27 See http://www.debian.org/releases/etch/debian-installer/
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
28
29 1.2 Set up apt sources for Git, Yaz and Zebra packages
30
31 Edit your /etc/apt/sources.list file and add the following:
32
33 # Index Data
34 deb http://ftp.indexdata.dk/debian etch main
35 deb-src http://ftp.indexdata.dk/debian etch main
36
37 # Backports
38 deb http://www.backports.org/debian etch-backports main contrib non-free
39
40 Backports packages are signed with a key you can install as follows:
41
b74320e @fredericd Some tweaks for Debian Etch install procedure
fredericd authored
42 $ sudo apt-get update
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
43 $ sudo apt-get install debian-backports-keyring
44
45 The Index Data packages are signed with a key you can install as follows:
46
47 $ wget http://ftp.indexdata.dk/debian/indexdata.asc
48 $ sudo apt-key add indexdata.asc
49
50 Run the following command to update your system:
51
52 $ sudo apt-get update
53 $ sudo apt-get -t etch-backports install git-core git-email
54 $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
55
844f1fa updates to some of the finer points of the install process on Etch
Joshua Ferraro authored
56 1.3 Get Koha
57
58 1.3.1 Option A: Download Koha via Git (optional)
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
59
60 $ git clone git://git.koha.org/pub/scm/koha.git kohaclone
61 $ cd kohaclone
62 $ git checkout -b myinstall origin
63
64 Note: for more information about Git, please see the Koha Git Usage Guide:
65
eedb944 updating INSTALL and INSTALL.debian
Joshua Ferraro authored
66 http://wiki.koha.org/doku.php?id=en:development:git_usage
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
67
844f1fa updates to some of the finer points of the install process on Etch
Joshua Ferraro authored
68 1.3.2 Option B: Download Koha from koha.org
69
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
70 1.4 Install additional Debian dependencies
71
d3dc1ad Updating README.debian
Chris Nighswonger authored
72 IMPORTANT: You should only use CPAN for Perl dependencies which are NOT available from the package maintainer.
73 You have been warned!
74
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
75 Using the debian.packages file included in the Koha source tree,
76 run the following:
77
78 $ sudo dpkg --set-selections < install_misc/debian.packages
79
80 Now start dselect:
81
82 $ sudo dselect
83
84 Choose [I]nstall and accept packages to be installed (hit return)
85
86 (may take a while)
87
88 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
89
90 1.5 Install Perl dependencies that aren't packaged into Debian Etch
91 sources
92
93 Run the following command:
94
8f82439 important: DBD::mysql 4.004 or later required
Galen Charlton authored
95 $ sudo cpan MARC::Record Class::Accessor MARC::Charset MARC::File::XML \
96 Net::Z3950::ZOOM HTML::Template::Pro MARC::Crosswalk::DublinCore \
97 PDF::Reuse PDF::Reuse::Barcode Data::ICal GD::Barcode::UPCE \
98 XML::RSS Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle POE Schedule::At
99
100 There is a known but benign error in the test case for Barcode::Code128,
101 which is required by PDF::Reuse::Barcode. If this module is not installed,
102 you can do a forced installation of Barcode::Code128.
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
103
104 Note: you may need to run CPAN initialization if you've not run cpan
105 before:
106
107 /etc/perl/CPAN/Config.pm initialized.
108
109 CPAN is the world-wide archive of perl resources. It consists of about
110 100 sites that all replicate the same contents all around the globe.
111 Many countries have at least one CPAN site already. The resources
112 found on CPAN are easily accessible with the CPAN.pm module. If you
113 want to use CPAN.pm, you have to configure it properly.
114
115 If you do not want to enter a dialog now, you can answer 'no' to this
116 question and I'll try to autoconfigure. (Note: you can revisit this
117 dialog anytime later by typing 'o conf init' at the cpan prompt.)
118
119 Are you ready for manual configuration? [yes]
120
121 When the configuration is completed CPAN will install the Perl modules.
122
123 2. Configuration of dependencies
124
125 2.1 Update root MySQL password (if dselect didn't do it for you already)
126
127 $ sudo mysqladmin password <password>
128
129 2.2 Create the Koha database
130
844f1fa updates to some of the finer points of the install process on Etch
Joshua Ferraro authored
131 Create the database and user with associated privileges:
132
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
133 $ mysqladmin -uroot -p<password> create database <kohadatabasename>
134 $ mysql -uroot -p<password>
135
136 Welcome to the MySQL monitor. Commands end with ; or \g.
137 Your MySQL connection id is 22
138 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
139
140 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
141
d3dc1ad Updating README.debian
Chris Nighswonger authored
142 mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
143 Query OK, 0 rows affected (0.00 sec)
144
145 mysql> flush privileges;
146 Query OK, 0 rows affected (0.00 sec)
147
148 mysql> quit
149
eedb944 updating INSTALL and INSTALL.debian
Joshua Ferraro authored
150 2.3 Test your SAX Parser and correct where necessary
151
152 You must be sure you're using the XML::LibXML SAX parser, not Expat or PurePerl, both of which have outstanding bugs with pre-composed characters. You can test your SAX parser by running:
153
154 $ misc/sax_parser_print.pl
155
156 You should see something like::
157
158 XML::LibXML::SAX::Parser=HASH(0x81fe220)
159
160 If you're using PurePerl or Expat, you'll need to edit your
161 ini file, typically located at:
162
163 /etc/perl/XML/SAX/ParserDetails.ini
164
165 2.4 Create test database in order to install DBD::mysql
8f82439 important: DBD::mysql 4.004 or later required
Galen Charlton authored
166
167 In order to handle UTF-8 correctly, Koha requires at least version 4.004
168 of the DBD::mysql Perl module. However, Debian Etch has a stable package
169 only for version 3.0008, so it is necessary to install the module from CPAN.
170 Because of DBD::mysql's test suite, it is necessary to temporarily create a
171 test database and user:
172
173 $ mysql -uroot -p<password>
174
175 Create the database and user with associated privileges:
176
177 Welcome to the MySQL monitor. Commands end with ; or \g.
178 Your MySQL connection id is 22
179 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
180
181 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
182
183 mysql> create database test;
184 Query OK, 1 row affected (0.00 sec)
185
186 mysql> grant all on test.* to 'test'@'localhost' identified by 'test';
187 Query OK, 0 rows affected (0.00 sec)
188 (test database, user, and password can be different if need be)
189
190 mysql> flush privileges;
191 Query OK, 0 rows affected (0.00 sec)
192
193 mysql> quit
194
195 Next install DBD::mysql:
196
197 $ sudo cpan
198
199 cpan> o conf makepl_arg
200 (get current value of this CPAN parameter)
201
202 cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test"
203
204 cpan> install DBD::mysql
205
206 cpan> o conf makepl_arg ''
207 (clear this setting to not interface with future CPAN installs).
208
209
210 Finally, remove the test database:
211
212 $ mysql -uroot -p<password>
213
214 mysql> drop database test;
215 Query OK, 1 row affected (0.00 sec)
216
217 mysql> exit
218 Bye
219
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
220 3. Run the Koha installer
221
222 $ perl Makefile.PL
223 ( answer questions )
224 $ make
225 $ make test
226 $ sudo make install
227
228 4. Configure and start Apache
229 $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
230 (note that the path to koha-httpd.conf may be different depending on your
231 installation choices)
232
9b14c38 adding ports information
Joshua Ferraro authored
233 Add the following lines to /etc/apache2/ports.conf:
234
235 Listen 80
236 Listen 8080
237
238 Run the following commands:
239
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
240 $ sudo a2enmod rewrite
77c6fcc fixes to README.debian
Joshua Ferraro authored
241 $ sudo a2ensite koha
242 $ sudo apache2ctl restart
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
243
dcb3858 Several important commits:
Joshua Ferraro authored
244 5. Configure and start Zebra
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
245
dcb3858 Several important commits:
Joshua Ferraro authored
246 Note: it's recommended that you daemonize the Zebra process and add it to your
247 startup profile. For a non-production test/development installation, running
248 Zebra from the command line can be useful. Pick from the two available options
249 below, or roll your own :-)
250
251 Note: it's also recommended that you create a Koha system user, which you will
252 have specified during the install process. Alternatively, Zebra can be
253 configured to run as the root user.
254
255 Option 1: run the Zebra processes from the command line:
256
257 Zebra Server:
9441380 more updates to README.debain
Joshua Ferraro authored
258 $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
259 (note that the path to koha-conf.xml may be different depending on your
260 installation choices)
261
85092da Warning: Big Commit. Fixing Virtual Shelves
Joshua Ferraro authored
262 Note: the user you run Zebra as will be the only user with write permission
263 on the Zebra index; in development mode, you may wish to use your system
264 user.
265
dcb3858 Several important commits:
Joshua Ferraro authored
266 Zebraqueue Daemon:
9441380 more updates to README.debain
Joshua Ferraro authored
267 $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
dcb3858 Several important commits:
Joshua Ferraro authored
268
85092da Warning: Big Commit. Fixing Virtual Shelves
Joshua Ferraro authored
269 Note: if you are running in this mode, you may wish to defer starting the
270 zebraqueue until you've run the web installer (see below).
271
dcb3858 Several important commits:
Joshua Ferraro authored
272 Option 2: run the Zebra processes as daemons, and add to startup process:
273
e6ee69b various installer changes
Galen Charlton authored
274 Note that references to $SCRIPT_DIR refer to the directory where
275 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
276
dcb3858 Several important commits:
Joshua Ferraro authored
277 Zebra Server:
e6ee69b various installer changes
Galen Charlton authored
278 $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh /etc/init.d/koha-zebra-daemon
9441380 more updates to README.debain
Joshua Ferraro authored
279 (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
77c6fcc fixes to README.debian
Joshua Ferraro authored
280 $ sudo update-rc.d koha-zebra-daemon defaults
dcb3858 Several important commits:
Joshua Ferraro authored
281 ( Note: see man chkconfig(8) on other distros )
77c6fcc fixes to README.debian
Joshua Ferraro authored
282
283 $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
dcb3858 Several important commits:
Joshua Ferraro authored
284
285 Zebraqueue Daemon:
e6ee69b various installer changes
Galen Charlton authored
286 $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh /etc/init.d/koha-zebraqueue-daemon
77c6fcc fixes to README.debian
Joshua Ferraro authored
287 $ sudo update-rc.d koha-zebraqueue-daemon defaults
dcb3858 Several important commits:
Joshua Ferraro authored
288 ( Note: see man chkconfig(8) on other distros )
289
77c6fcc fixes to README.debian
Joshua Ferraro authored
290 $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
e6ee69b various installer changes
Galen Charlton authored
291
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
292 6. Run the Web Installer, populate the database, initial configuration of settings
293
294 Point your browser to http://<servername>:8080/
295
296 It should redirect you to the Web installer where you can continue the setup.
297
298 Uninstall Instructions
299 =============================
9441380 more updates to README.debain
Joshua Ferraro authored
300 1) Stop Services:
301 $ sudo a2dissite koha
302 $ sudo rm /etc/apache2/sites-available/koha
303 $ sudo apache2ctl restart
304
305 $ sudo update-rc.d koha-zebra-daemon remove
306 $ sudo update-rc.d koha-zebraqueue-daemon remove
307 $ sudo rm /etc/init.d/koha-zebra-daemon
308 $ sudo rm /etc/init.d/koha-zebraqueue-daemon
309
844f1fa updates to some of the finer points of the install process on Etch
Joshua Ferraro authored
310 2) Remove Koha Databases
85092da Warning: Big Commit. Fixing Virtual Shelves
Joshua Ferraro authored
311
312 # MySQL
313 $ mysql -u<kohauser> -p<kohapassword>
314 > drop database koha;
315
316 # Zebra Indexes
317 $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
318 $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
319
844f1fa updates to some of the finer points of the install process on Etch
Joshua Ferraro authored
320 3) Remove Koha Install Directories and Configuration Files
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
321
322 Tested on the following operating environments
323 ==============================================
324 - Debian Etch 4.0
325
326 Installer Bug reports
327 =====================
dcb3858 Several important commits:
Joshua Ferraro authored
328 Please send any installer bug reports to jmf AT liblime DOT com
fa212d4 adding debian-specific installation guide
Joshua Ferraro authored
329
330 Other Notes
331 =====================
332 This file is part of Koha
333
334 Koha is free software; you can redistribute it and/or modify it under the
335 terms of the GNU General Public License as published by the Free Software
336 Foundation; either version 2 of the License, or (at your option) any later
337 version.
338
339 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
340 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
341 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
342 You should have received a copy of the GNU General Public License along with
343 Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
344 Suite 330, Boston, MA 02111-1307 USA
Something went wrong with that request. Please try again.