ffzg/recall_notices.pl: added --interval and --dedup

[koha.git] / debian / koha-common.README.Debian

diff --git a/debian/koha-common.README.Debian b/debian/koha-common.README.Debian
index 221e1a3..ba831af 100644 (file)
--- a/debian/koha-common.README.Debian
+++ b/debian/koha-common.README.Debian
@@ -1,3 +1,31 @@
+Post-installation configuration
+===============================
+
+You will want to consider doing the following after installing this
+package:
+
+* Install mysql-server, for a local database.
+
+* Alternatively, set up a connection to a remote MySQL server:
+  - rm /etc/mysql/koha-common.cnf
+  - $EDITOR /etc/mysql/koha-common.cnf
+
+        [client]
+        host = some.other.host
+        user = mysqlusername
+        password = mysqlpassword
+        
+* Enable the rewrite module: a2enmod rewrite
+
+* Listen on port 8080: $EDITOR /etc/apache2/ports.conf
+
+* Alternatively, configure koha-create, using /etc/koha/koha-sites.conf
+  (see /usr/sbin/koha-create for which variables to set).
+  
+* After that, you can create a new Koha instance:
+  - koha-create --create-db name
+
+
 Koha filesystem layout on Debian
 ================================
 
@@ -5,6 +33,8 @@ The Debian packaging of Koha puts files in the following places:
 
 * /etc/koha -- system configuration files
 * /etc/cron.hourly/koha-common -- cron job
+* /etc/cron.daily/koha-common -- cron job
+* /etc/cron.d/koha-common -- cron job
 * /usr/share/koha -- shared files (HTML templates, Perl code, etc)
 
 Each Koha instance has files in the following places:
@@ -17,3 +47,13 @@ Each Koha instance has files in the following places:
 * /var/run/koha/$name -- run-time sockets etc
 * /var/spool/koha/$name -- database dumps
 
+
+Koha and MySQL
+==============
+
+koha-common's postinst script sets up the /etc/mysql/koha-common.cnf,
+and all scripts use that to access the MySQL database. By default, it
+is a symlink pointing at debian.cnf, and only works on localhost.
+If you wish, you can create a file /etc/mysql/koha-common.cnf instead
+of the symlink, and point it at a remote server. There is currently
+no tool to help you do that, but it should be fairly straightforward.