INSTALL

   1 Koha 3.2 - 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 2. make
  34 3.(optional) make test
  35 4. sudo make install
  36 5. sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
  37   (note that the path to koha-httpd.conf may be different depending on your
  38   installation choices)
  39 6. sudo a2enmod rewrite deflate
  40 7. sudo a2ensite koha && /etc/init.d/apache2 reload
  41 8. sudo zebrasrv -f /etc/koha/koha-conf.xml
  42   (note that you will want to run Zebra in daemon mode for a production
  43   system)
  44 9. Browse to http://servername:8080/ and answer the questions
  45 10. Optionally add a robots.txt file.  See README.robots for details
  46
  47 OR if you want to install all dependencies from CPAN and are root, you can
  48 replace steps 1-3 with "perl install-CPAN.pl" but this is non-standard and
  49 may not be safe.  Nevertheless, it's pretty cool when it works.
  50
  51 The defaults will install Koha to places that follow relevant standards,
  52 such as the File Hierarchy Standard.  If you want to install Koha to a
  53 different directory like /opt/koha, then replace step 1 with (for example):
  54
  55 1. perl Makefile.PL INTRANET_CGI_DIR=/www/cgi-bin
  56
  57 You can change most of the defaults in a similar way, such as DB_HOST.
  58 For full instructions on how to override the default settings, run
  59
  60 $ perldoc rewrite-config.PL
  61
  62 UPGRADE
  63 =======
  64 If you are running in another language other than english, please
  65 switch to english before doing the upgrade, the templating system has
  66 changed and the templates will need to be regenerated.
  67 Once you have upgraded, please regenerate your templates in your
  68 chosen languages.
  69
  70 If you are upgrading from a previous installation of Koha 3.x, you can
  71 use the following:
  72
  73  ./koha_perl_deps.pl -u -m # to identify new Perl dependencies
  74
  75 Install any missing modules
  76 IMPORTANT: Koha 3.4.0 and greater uses Template::Toolkit, this must be installed
  77 before the webinstaller can run
  78
  79 On debian/ubuntu
  80  sudo apt-get install libtemplate-perl
  81
  82 Other Linux/Unix platforms
  83 Use the packaged version or install from CPAN
  84   cpan Template
  85
  86  perl Makefile.PL --prev-install-log /path/to/koha-install-log
  87  make
  88  make test
  89  sudo make upgrade
  90
  91 Koha 3.4.x or later  no longer stores items in biblio records.
  92 If you are upgrading from an older version ou will need to do the
  93 following two steps, they can take a long time (several hours) to
  94 complete for large databases
  95
  96  misc/maintenance/remove_items_from_biblioitems.pl --run
  97  misc/migration_tools/rebuild_zebra.pl -b -r
  98
  99 WHAT NEXT?
 100
 101 1. Running the Web Installer allows you to install sample data for libraries, patrons, etc.
 102     but you may want to install additional data such as bibliographic and authorities.
 103
 104     Once the installer has completed, you can import and index MARC records from the
 105     command line thusly (Note: you can also use the 'Stage MARC records for import' from
 106     the Tools area of Koha's Staff Client to import a batch of MARC records):
 107
 108     $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
 109       (note: use the correct path to your koha-conf.xml)
 110
 111 2. Import:
 112     Bibliographic data in MARC21 format
 113     $ misc/migration_tools/bulkmarcimport.pl -file /path/to/marc.iso2709
 114     Authority data in MARC21 format
 115     $ misc/migration_tools/bulkauthimport.pl -file /path/to/auth.iso2709
 116
 117 3. Fast Index:
 118     $ misc/migration_tools/rebuild_zebra.pl -b -w
 119
 120     Once the indexing has completed, you will be able to search for records in your
 121     system. NOTE: if you don't run the Fast Index utility, and you have the index
 122     updates scheduled as per 7.3 the indexing process will happen in the background,
 123     Once the indexing has completed, you will be able to search for records in your
 124     system. NOTE: if you don't run the Fast Index utility, and you have the index
 125     updates scheduled as per 7.3 the indexing process will happen in the background,
 126     but it will be orders of magnitude slower.
 127
 128 4. Schedule regular index updates
 129     run rebuild_zebra.pl -b -a -z as a regular cron job, check misc/cronjobs/crontab.example
 130     for usage examples
 131
 132 5. To enable public Z39.50/SRU servers, you'll need to edit your koha-conf.xml and
 133     change the <listen> options to listen on a TCP port; then restart the zebra daemon.
 134
 135
 136 IF YOU HAVE PROBLEMS
 137 ====================
 138
 139 IF THIS IS A PRE-RELEASE TREE: please contact developers by email via
 140 http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
 141 or
 142 http://dir.gmane.org/gmane.education.libraries.koha.devel
 143
 144 IF THIS IS A RELEASED VERSION: please see the support pages at
 145 http://www.koha-community.org/
 146
 147 Released versions usually have three-digit numbers, like 3.06.00,
 148 while other version number styles are usually snapshots or previews.
 149
 150
 151 DEVELOPER NOTES
 152 ===============
 153
 154 For instructions on how to package releases, run perldoc Makefile.PL