README.txt

   1 Koha - award-winning GPL Integrated Library System
   2
   3 Koha aims to be a full-featured Integrated Library System. Developed
   4 initially in New Zealand by Katipo Communications Ltd and first deployed
   5 in January of 2000 for Horowhenua Library Trust, it is currently
   6 maintained by a team of software providers and library technology staff
   7 from around the globe.
   8
   9
  10 STRUCTURE
  11 =========
  12
  13 Koha 3.0 has been restructured from Koha 2.2 to use Zebra,
  14 a high-performance, general-purpose structured text indexing and
  15 retrieval engine.  Zebra speaks Z39.50, building on one of Koha's most
  16 useful features.
  17
  18 General library data is held in MySQL, and Koha 3.0 supports MySQL 5,
  19 using foreign keys and other recent features.
  20
  21 Apache 2 is the recommended web server and VirtualHost configuration
  22 files are generated for it.
  23
  24
  25 INSTALLATION
  26 ============
  27
  28 Koha 3.0 comes with a new installer, based on MakeMaker, the tool that
  29 is usually used to install CPAN modules.  This means that if you know
  30 how to customise CPAN-installed modules, the same things should work
  31 for you with Koha.  If not, don't worry.  If you want to customise the
  32 installation more than described below, run "man ExtUtils::MakeMaker"
  33
  34 You need to have a server running MySQL 5, Zebra and some webserver
  35 (preferably Apache) before installing Koha.  Create a database in
  36 MySQL called koha, owned by a kohaadmin user, with a password set.
  37
  38 Default installation instructions:
  39
  40 0. export MYSQL_PASS=thePasswordYouChose
  41 1. perl Makefile.PL
  42 2. make
  43 3. sudo make install
  44 4. ln -s /usr/share/koha/etc/koha-httpd.conf /etc/apache2/sites-available/koha
  45 5. a2ensite koha && /etc/init.d/apache reload
  46 6. zebrasrv -c /usr/share/koha/etc/koha-conf.xml
  47 7. Browse to http://servername:8080/ and answer the questions
  48
  49 OR if you want to install all dependencies from CPAN and are root, you can
  50 replace steps 1-3 with "perl install-CPAN.pl" but this is non-standard and
  51 may not be safe.  Nevertheless, it's pretty cool when it works.
  52
  53 The defaults will install Koha to places that follow relevant standards,
  54 such as the File Hierarchy Standard.  If you want to install Koha to a
  55 different directory like /opt/koha, then replace step 1 with:
  56 1a. export PREFIX=/opt/koha
  57 1b. export CGI_DIR=/opt/koha/cgi
  58 1c. export LOG_DIR=/opt/koha/log
  59 1d. perl Makefile.PL PREFIX=/opt/koha
  60
  61 You can change most of the defaults in a similar way, such as MYSQL_HOST.
  62 For full instructions on how to override the default settings, run
  63 perldoc rewrite-config.PL
  64
  65
  66 IF YOU HAVE PROBLEMS
  67 ====================
  68
  69 IF THIS IS A PRE-RELEASE TREE: please contact developers by email via
  70 http://lists.nongnu.org/mailman/listinfo/koha-devel
  71 or
  72 http://dir.gmane.org/gmane.education.libraries.koha.devel
  73
  74 IF THIS IS A RELEASED VERSION: please see the support pages at
  75 http://www.koha.org/
  76
  77 Released versions usually have three-digit numbers, like 3.00.01,
  78 while other version number styles are usually snapshots or previews.
  79
  80
  81 DEVELOPER NOTES
  82 ===============
  83
  84 For instructions on how to package releases, run perldoc Makefile.PL