Updating perlcriticrc to allow Modern::Perl to suffice instead of use warnings; and...
[koha.git] / debian / koha-common.README.Debian
1 Post-installation configuration
2 ===============================
3
4 You will want to consider doing the following after installing this
5 package:
6
7 * Install mysql-server, for a local database.
8
9 * Alternatively, set up a connection to a remote MySQL server:
10   - rm /etc/mysql/koha-common.cnf
11   - $EDITOR /etc/mysql/koha-common.cnf
12
13         [client]
14         host = some.other.host
15         user = mysqlusername
16         password = mysqlpassword
17         
18 * Enable the rewrite module: a2enmod rewrite
19
20 * Listen on port 8080: $EDITOR /etc/apache2/ports.conf
21
22 * Alternatively, configure koha-create, using /etc/koha/koha-sites.conf
23   (see /usr/sbin/koha-create for which variables to set).
24   
25 * After that, you can create a new Koha instance:
26   - koha-create --create-db name
27
28
29 Koha filesystem layout on Debian
30 ================================
31
32 The Debian packaging of Koha puts files in the following places:
33
34 * /etc/koha -- system configuration files
35 * /etc/cron.hourly/koha-common -- cron job
36 * /etc/cron.daily/koha-common -- cron job
37 * /etc/cron.d/koha-common -- cron job
38 * /usr/share/koha -- shared files (HTML templates, Perl code, etc)
39
40 Each Koha instance has files in the following places:
41
42 * /etc/koha/sites/$name -- confguration files
43 * /etc/apache2/sites-available/$name -- Apache config file
44 * /var/lib/koha/$name -- Zebra databases
45 * /var/log/koha/$name -- log files (Apache, Zebra)
46 * /var/lock/koha/$name -- run-time lock files
47 * /var/run/koha/$name -- run-time sockets etc
48 * /var/spool/koha/$name -- database dumps
49
50
51 Koha and MySQL
52 ==============
53
54 koha-common's postinst script sets up the /etc/mysql/koha-common.cnf,
55 and all scripts use that to access the MySQL database. By default, it
56 is a symlink pointing at debian.cnf, and only works on localhost.
57 If you wish, you can create a file /etc/mysql/koha-common.cnf instead
58 of the symlink, and point it at a remote server. There is currently
59 no tool to help you do that, but it should be fairly straightforward.