INSTALL

   1 Koha 3 - the next-generation release of the award-winning Koha open-source
   2 integrated library system.
   3
   4 Koha is the first open-source Integrated Library System. Developed initially in
   5 New Zealand by Katipo Communications, Ltd and first deployed in January of 2000
   6 for the Horowhenua Library Trust, it is currently maintained by a team of
   7 software providers and library technology staff from around the globe. Learn
   8 more about the Koha project at http://koha-community.org.
   9
  10 INSTALLATION
  11 ============
  12
  13 You need to have a server running Perl 5.10 or later, MySQL 5, Zebra
  14 2.0.22 or greater and a webserver (preferably Apache2) before installing
  15 Koha.
  16
  17 MySQL 5: Create a database called 'koha,' owned by 'kohaadmin'
  18 user, with a password set. Note: kohaadmin must have at least the
  19 following privileges: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP,
  20 ALTER, and LOCK TABLES.
  21
  22 Default installation instructions:
  23
  24 1. perl Makefile.PL
  25   (you will be prompted to answer a number of questions and you will
  26   need to install some Perl dependencies)
  27   WARNING:
  28
  29   1.1 recent versions of CGI::Session have caused some issues for users;
  30   as of this release date, we suggest downloading the CGI::Session::serialize::yaml
  31   tarball direct from CPAN and install it directly rather than using the cpan command
  32
  33   1.2. Optional foreign language installation:
  34   If you would like more languages and not only English,
  35     cd misc/translator
  36     perl translate install fr-FR # or use your preferred language codes
  37
  38 2. make
  39 3.(optional) make test
  40 4. sudo make install
  41 5. sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
  42   (note that the path to koha-httpd.conf may be different depending on your
  43   installation choices)
  44 6. sudo a2enmod rewrite deflate
  45 7. sudo a2ensite koha && /etc/init.d/apache2 reload
  46 8. sudo zebrasrv -f /etc/koha/koha-conf.xml
  47   (note that you will want to run Zebra in daemon mode for a production
  48   system)
  49 9. Browse to http://servername:8080/ and answer the questions
  50 10. Optionally add a robots.txt file.  See README.robots for details
  51
  52 OR if you want to install all dependencies from CPAN and are root, you can
  53 replace steps 1-3 with "perl install-CPAN.pl" but this is non-standard and
  54 may not be safe.  Nevertheless, it's pretty cool when it works.
  55
  56 The defaults will install Koha to places that follow relevant standards,
  57 such as the File Hierarchy Standard.  If you want to install Koha to a
  58 different directory like /opt/koha, then replace step 1 with (for example):
  59
  60 1. perl Makefile.PL INTRANET_CGI_DIR=/www/cgi-bin
  61
  62 You can change most of the defaults in a similar way, such as DB_HOST.
  63 For full instructions on how to override the default settings, run
  64
  65 $ perldoc rewrite-config.PL
  66
  67 UPGRADE
  68 =======
  69 If you are running in another language other than english, please
  70 switch to english before doing the upgrade, the templating system has
  71 changed and the templates will need to be regenerated.
  72 Once you have upgraded, please regenerate your templates in your
  73 chosen languages.
  74
  75 If you are upgrading from a previous installation of Koha 3.x, you can
  76 use the following:
  77
  78  ./koha_perl_deps.pl -u -m # to identify new Perl dependencies
  79
  80 Install any missing modules
  81 IMPORTANT: Koha 3.4.0 and greater uses Template::Toolkit, this must be installed
  82 before the webinstaller can run
  83
  84 On debian/ubuntu
  85  sudo apt-get install libtemplate-perl
  86
  87 Other Linux/Unix platforms
  88 Use the packaged version or install from CPAN
  89   cpan Template
  90
  91  perl Makefile.PL --prev-install-log /path/to/koha-install-log
  92  make
  93  make test
  94  sudo make upgrade
  95
  96 Koha 3.4.x or later  no longer stores items in biblio records.
  97 If you are upgrading from an older version ou will need to do the
  98 following two steps, they can take a long time (several hours) to
  99 complete for large databases
 100
 101  misc/maintenance/remove_items_from_biblioitems.pl --run
 102  misc/migration_tools/rebuild_zebra.pl -b -r
 103
 104 WHAT NEXT?
 105
 106 1. Running the Web Installer allows you to install sample data for libraries, patrons, etc.
 107     but you may want to install additional data such as bibliographic and authorities.
 108
 109     Once the installer has completed, you can import and index MARC records from the
 110     command line thusly (Note: you can also use the 'Stage MARC records for import' from
 111     the Tools area of Koha's Staff Client to import a batch of MARC records):
 112
 113     $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
 114       (note: use the correct path to your koha-conf.xml)
 115
 116 2. Import:
 117     Bibliographic data in MARC21 format
 118     $ misc/migration_tools/bulkmarcimport.pl -file /path/to/marc.iso2709
 119     Authority data in MARC21 format
 120     $ misc/migration_tools/bulkauthimport.pl -file /path/to/auth.iso2709
 121
 122 3. Fast Index:
 123     $ misc/migration_tools/rebuild_zebra.pl -b -w
 124
 125     Once the indexing has completed, you will be able to search for records in your
 126     system. NOTE: if you don't run the Fast Index utility, and you have the index
 127     updates scheduled as per 7.3 the indexing process will happen in the background,
 128     but it will be orders of magnitude slower.
 129
 130 4. Schedule regular index updates
 131     run rebuild_zebra.pl -b -a -z as a regular cron job, check the 'misc/cronjobs/crontab.example' file for usage examples
 132
 133     You can also configure zebra-indexing as an background daemon, see http://wiki.koha-community.org/wiki/Background_indexing_with_Zebra
 134
 135 5. To enable public Z39.50/SRU servers, you'll need to edit your koha-conf.xml and
 136     change the <listen> options to listen on a TCP port; then restart the zebra daemon.
 137
 138
 139 IF YOU HAVE PROBLEMS
 140 ====================
 141
 142 IF THIS IS A PRE-RELEASE TREE: please contact developers by email via
 143 http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
 144 or
 145 http://dir.gmane.org/gmane.education.libraries.koha.devel
 146
 147 IF THIS IS A RELEASED VERSION: please see the support pages at
 148 http://www.koha-community.org/
 149
 150 Released versions usually have three-digit numbers, like 3.06.00,
 151 while other version number styles are usually snapshots or previews.
 152
 153
 154 DEVELOPER NOTES
 155 ===============
 156
 157 For instructions on how to package releases, run perldoc Makefile.PL