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 Koha 3.0 introduces multi-dbms support. With this release you may elect
  35 to install over MySQL 5 or PostgreSQL 8.2.5. Further databases will
  36 be added over time.
  37
  38 You need to have a server running MySQL 5 or PostgreSQL 8.2.5, Zebra
  39 and some webserver (preferably Apache) before installing Koha.
  40
  41 MySQL 5: Create a database called 'koha,' owned by 'kohaadmin'
  42 user, with a password set. Note: kohaadmin must have at least the
  43 following privileges: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP.
  44
  45 PostgreSQL 8.2.5: Create a database called 'koha,' owned by 'kohaadmin'
  46 user, with a password set. Note: kohaadmin must be a superuser. You
  47 must also add plpgsql to the koha database.
  48
  49 Default installation instructions:
  50
  51 1. perl Makefile.PL
  52   (you will be prompted to answer a number of questions)
  53 2. make
  54 3.(optional) make test
  55 4. sudo make install
  56 5. ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
  57 6. a2enmod rewrite
  58 7. a2ensite koha && /etc/init.d/apache2 reload
  59 8. zebrasrv -f /usr/share/koha/etc/koha-conf.xml
  60 9. Browse to http://servername:8080/ and answer the questions
  61
  62 OR if you want to install all dependencies from CPAN and are root, you can
  63 replace steps 1-3 with "perl install-CPAN.pl" but this is non-standard and
  64 may not be safe.  Nevertheless, it's pretty cool when it works.
  65
  66 The defaults will install Koha to places that follow relevant standards,
  67 such as the File Hierarchy Standard.  If you want to install Koha to a
  68 different directory like /opt/koha, then replace step 1 with (for example):
  69 1. perl Makefile.PL INTRANET_CGI_DIR=/www/cgi-bin
  70
  71 You can change most of the defaults in a similar way, such as DB_HOST.
  72 For full instructions on how to override the default settings, run
  73 perldoc rewrite-config.PL
  74
  75
  76 IF YOU HAVE PROBLEMS
  77 ====================
  78
  79 IF THIS IS A PRE-RELEASE TREE: please contact developers by email via
  80 http://lists.nongnu.org/mailman/listinfo/koha-devel
  81 or
  82 http://dir.gmane.org/gmane.education.libraries.koha.devel
  83
  84 IF THIS IS A RELEASED VERSION: please see the support pages at
  85 http://www.koha.org/
  86
  87 Released versions usually have three-digit numbers, like 3.00.01,
  88 while other version number styles are usually snapshots or previews.
  89
  90
  91 DEVELOPER NOTES
  92 ===============
  93
  94 For instructions on how to package releases, run perldoc Makefile.PL