INSTALL

   1 Koha - Requirements and quick-start installation guide
   2
   3 For additional information on how your Configuration files should look
   4 see the Hints file.
   5
   6 Important....
   7 To successfully use Koha you need some additional software:
   8
   9 A webserver (It was built to work with Apache, but there is no reason
  10 it shouldn't work with any other webserver).
  11 Mysql (You could intead use postgres, or another sql based database)
  12 Perl (mod_perl isn't needed, though koha should work with mod_perl --
  13 note that this hasn't been tested yet).
  14
  15 Perl Modules:
  16
  17 Date::Manip
  18 DBI
  19 Set::Scalar
  20 DBD::mysql (or whatever database system you use)
  21 AuthenDBI (if you want to use Database based authentication)
  22 CDK (for the telnet interface not necessary if you plan to use the web
  23 based circulation module) also requires installation of the C CDK
  24 libraries http://www.vexus.ca/CDK.html ( CDKModuleHasProblems )
  25
  26 --------------------------------------------------------------------------------
  27
  28
  29 Quick-start Installation Guide
  30 (Assumes the Use of MySQL and Apache)
  31
  32 1. Create a new mysql database called for example Koha
  33 From command line: mysqladmin -uroot -ppassword create Koha
  34 There is a databse installation shell script included with the Koha tarball.
  35
  36 2. Set up a koha user and password in mysql
  37 Log in to mysql: mysql -uroot -ppassword
  38
  39 To create a user called "koha" who has full administrative rights to
  40 the "Koha" database when authenticating from "localhost", enter the
  41 following on mysql command line:
  42
  43 grant all privileges on Koha.* to koha@localhost identified by 'kohapassword';
  44
  45 Press ENTER, and if you see no errors then enter \q to quit mysql.
  46
  47
  48 3. Use the mysql script to create the tables
  49 mysql -uusername -ppassword Koha < koha.mysql
  50
  51 4. Edit koha.conf
  52 Set the database name to what you have called your database, hostname
  53 willprobably stay as localhost (unless you are installing the database
  54 on a different machine to the webserver) User and password should be
  55 changed to reflect the username and password you have chosen above.
  56
  57 You can include a line called "includes= " with path to your includes
  58 folder instead of entering the path in Output.pm - see example in
  59 Hints.
  60
  61
  62 5. Copy koha.conf to /etc/
  63 The permissions on this config file should also be strict, since they
  64 contain the database password. At a minimum, the apache user needs to
  65 be able to read it, as well as any other user that runs circ.
  66
  67 I would suggest ownership of www-data.libadmins with no access to
  68 others.libadmins contain all users that use koha (If you set the owner
  69 as www-data u will need to make sure apache is running
  70 as www-data)
  71
  72 6. Update your database tables
  73 perl -I modules/ scripts/updater/updatedatabase
  74
  75 7. Create directories for scripts and html documents.
  76 Here you need to decide where your scripts and html are going to live.
  77 And edit modules/C4/Output.pm to reflect that.
  78 Set $path= where your includes live,
  79 for example: $path="/usr/local/www/koha/htdocs/includes";
  80
  81 You do not need to do that if you have already entered the includes
  82 path in koha.conf (see example above)
  83
  84 Next copy the C4 directory (in modules/) to somewhere in your perl path
  85 eg /usr/local/lib/site_perl/i386-linux/
  86
  87 If you do not have sufficient access to copy the files to the default
  88 perl folder (maybe you are using your ISPs hosting server) then you
  89 can copy the modules to any other location and add a line to
  90 apache.conf like:
  91
  92 SetEnv PERL5LIB "/usr/local/www/koha/modules"
  93
  94 Copy the C4 directory into the modules folder (see detailed example in
  95 Hints)
  96
  97
  98 8. Set up your Online Public Access Catalogue (OPAC)
  99
 100 Set up a webspace for the OPAC: For example: You might make
 101 /usr/local/www/opac ... and set a virtual host in apache to use that
 102 dir
 103 In your opac dir make a dir called htdocs, and copy everything in
 104 opac-html/ to it.
 105 Again in ur opac dir make a dir called cgi-bin and copy all the files in
 106 opac-cgi/ that have a .pl extension to it, eg copy opac-cgi/*.pl
 107 /usr/local/www/opac/cgi-bin/koha/
 108 Your virtual host should be set up to use these dirs, some thing like this:
 109
 110
 111    <VirtualHost opac.your.site>
 112    ServerAdmin webmaster@your.site
 113    DocumentRoot /usr/local/www/opac/htdocs
 114    ScriptAlias  /cgi-bin/koha/ /usr/local/www/opac/cgi-bin/
 115    ServerName opac.your.site
 116    ErrorLog logs/opac-error_log
 117    TransferLog logs/opac-access_log
 118    </VirtualHost>
 119
 120
 121 When finished, restart apache and point your browser at opac.your.site
 122 and it should be all go (of course - if you dont have any data in the
 123 database there won't be much to see!)
 124
 125 Find supplementary information and config examples in Hints
 126
 127 9. Set up the intranet/librarian interface
 128
 129 Create new directories and additional httpd.conf changes to Set up
 130 another webspace. Lets call it koha.
 131 For example:
 132
 133 In the dir you have just created make an htdocs dir and a cgi-bin dir
 134 Copy everything in intranet-html/ to the htdocs dir
 135 Copy all the .pl files in intranet-cgi/ to the cgi-bin/koha dir
 136 Make sure your virtual host is set up to use these dirs
 137 Restart apache point your browser at koha.your.site and it should work
 138
 139
 140 10. Configure SECURITY for the Librarians/Intranet Interface
 141 If you are using AuthenDBI to do your authentication, you will need to
 142 add some users to the users table in the koha database. And edit your
 143 apache conf file to use AuthenDBI on the intranet site.
 144
 145 Otherwise, set up htaccess files in both koha/htdocs/ and koha/cgi-bin
 146 You can use general .htaccess based security. It is important though
 147 to password protect the librarians interface because from it you can
 148 delete and add items, remove borrowers fines and generally case
 149 havoc.
 150
 151
 152 11. Set up Issues, Returns and Telnet interface.
 153 Since we have already copied the files in scripts/C4 into somewhere in
 154 our perl source tree
 155
 156 We just need to now copy the scripts from scripts/telnet/ into
 157 somewhere in the executable path, eg /usr/local/bin
 158
 159 Then its done: type circ and your away, ready to issue and return.
 160
 161 Since release 1.1.0 on there is now a web-based circulation module, So
 162 issues and returns can be done from there, or from circ.
 163
 164
 165 You will find some Koha config examples in Hints