Win32 support: Switch DEBUG off and corrected warning bug.
[koha.git] / README.txt
index 1e8d246..018b73d 100644 (file)
@@ -28,30 +28,68 @@ INSTALLATION
 Koha 3.0 comes with a new installer, based on MakeMaker, the tool that
 is usually used to install CPAN modules.  This means that if you know
 how to customise CPAN-installed modules, the same things should work
-for you with Koha.
+for you with Koha.  If not, don't worry.  If you want to customise the
+installation more than described below, run "man ExtUtils::MakeMaker"
 
-You need to have a server running MySQL 5, Zebra and some webserver
-(preferably Apache) before installing Koha.  Create a database in
-MySQL called koha and 
+Koha 3.0 introduces multi-dbms support. With this release you may elect
+to install over MySQL 5 or PostgreSQL 8.2.5. Further databases will
+be added over time.
+
+You need to have a server running MySQL 5 or PostgreSQL 8.2.5, Zebra
+and some webserver (preferably Apache) before installing Koha.
+MySQL 5: Create a database called 'koha,' owned by 'kohaadmin'
+user, with a password set. Note: kohaadmin must have at least the
+following privileges: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP,
+ALTER, and LOCK TABLES.
+
+PostgreSQL 8.2.5: Create a database called 'koha,' owned by 'kohaadmin' 
+user, with a password set. Note: kohaadmin must be a superuser. You
+must also add plpgsql to the koha database.
 
 Default installation instructions:
 
 1. perl Makefile.PL
+  (you will be prompted to answer a number of questions)
 2. make
-3. sudo make install
-4. ln -s /usr/lib/perl5/site-perl/*/koha/etc/koha-httpd.conf /etc/apache2/sites-available/koha
-5. a2ensite koha && /etc/init.d/apache reload
-6. zebrasrv -c /usr/lib/perl5/site-perl/*/koha/etc/koha-conf.xml
-7. Browse to http://servername:8080/ and answer the questions
+3.(optional) make test 
+4. sudo make install
+5. ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
+6. a2enmod rewrite
+7. a2ensite koha && /etc/init.d/apache2 reload
+8. zebrasrv -f /etc/koha/koha-conf.xml
+9. Browse to http://servername:8080/ and answer the questions
 
 OR if you want to install all dependencies from CPAN and are root, you can
 replace steps 1-3 with "perl install-CPAN.pl" but this is non-standard and
 may not be safe.  Nevertheless, it's pretty cool when it works.
 
-For instructions on how to override the default settings, run
+The defaults will install Koha to places that follow relevant standards,
+such as the File Hierarchy Standard.  If you want to install Koha to a
+different directory like /opt/koha, then replace step 1 with (for example):
+1. perl Makefile.PL INTRANET_CGI_DIR=/www/cgi-bin
+
+You can change most of the defaults in a similar way, such as DB_HOST.
+For full instructions on how to override the default settings, run
 perldoc rewrite-config.PL
 
 
+IF YOU HAVE PROBLEMS
+====================
+
+IF THIS IS A PRE-RELEASE TREE: please contact developers by email via
+http://lists.nongnu.org/mailman/listinfo/koha-devel
+or
+http://dir.gmane.org/gmane.education.libraries.koha.devel
+
+IF THIS IS A RELEASED VERSION: please see the support pages at
+http://www.koha.org/
+
+Released versions usually have three-digit numbers, like 3.00.01,
+while other version number styles are usually snapshots or previews.
+
+
 DEVELOPER NOTES
+===============
 
 For instructions on how to package releases, run perldoc Makefile.PL