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