Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 163 lines (131 sloc) 5.117 kb
e449c13 @mjray Add configuration file helper to the installer
mjray authored
1 # Copyright 2007 MJ Ray
2 #
3 # This file is part of Koha.
4 #
5 # Koha is free software; you can redistribute it and/or modify it under the
6 # terms of the GNU General Public License as published by the Free Software
7 # Foundation; either version 2 of the License, or (at your option) any later
8 # version.
9 #
10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU General Public License along with
15 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
16 # Suite 330, Boston, MA 02111-1307 USA
17 #
18 # Current maintainer MJR http://mjr.towers.org.uk/
19 # See http://www.koha.org/wiki/?page=KohaInstaller
98782b8 Correct comments and POD to reflect keyword additions/changes
Chris Nighswonger authored
20 #
21 # 2007/11/12 Added DB_PORT and changed other keywords to reflect multi-dbms support. -fbcit
e449c13 @mjray Add configuration file helper to the installer
mjray authored
22
23 use Sys::Hostname;
24 use Socket;
25
26 =head1 NAME
27
28 rewrite-config.PL - helper for the Koha packager and installer
29
30 =head1 SYNOPSIS
31
32 perl rewrite-config.PL configurationfile
33
34 =head1 DESCRIPTION
35
61190e9 @mjray New installation instructions and release notes.
mjray authored
36 This helper script replaces keywords in the
e449c13 @mjray Add configuration file helper to the installer
mjray authored
37 configuration files with value either supplied through
38 the environment (with export, or by putting them on
61190e9 @mjray New installation instructions and release notes.
mjray authored
39 the start of the make command line) or with reasonable
e449c13 @mjray Add configuration file helper to the installer
mjray authored
40 guesses worked out by the script.
41
61190e9 @mjray New installation instructions and release notes.
mjray authored
42 =head2 KEYWORDS
e449c13 @mjray Add configuration file helper to the installer
mjray authored
43
61190e9 @mjray New installation instructions and release notes.
mjray authored
44 The following configuration keywords are available:
e449c13 @mjray Add configuration file helper to the installer
mjray authored
45
243ec54 @mjray Move many files to more FHS-like paths
mjray authored
46 PREFIX,
d1f9665 Now using install_base instead of prefix
Chris Cormack authored
47 BASE_DIR, CGI_DIR, LOG_DIR, INSTALL_BASE,
98782b8 Correct comments and POD to reflect keyword additions/changes
Chris Nighswonger authored
48 DB_TYPE, DB_HOST, DB_PORT, DB_NAME, DB_PASS, DB_USER, WEBMASTER_EMAIL, WEBSERVER_DOMAIN,
28695e9 @mjray Add missing auto_install features to new installer
mjray authored
49 WEBSERVER_HOST, WEBSERVER_IP, WEBSERVER_PORT, WEBSERVER_PORT_LIBRARIAN, ZEBRA_PASS, ZEBRA_USER
e449c13 @mjray Add configuration file helper to the installer
mjray authored
50
61190e9 @mjray New installation instructions and release notes.
mjray authored
51 =head1 EXAMPLES
52
53 To override the guessed hostname and email address, run:
54
55 WEBSERVER_HOST=mysecrethostname.com.invalid \
56 WEBMASTER_EMAIL=webmaster@publichost.com make install
57
58 Note that if WEBSERVER_HOST does not resolve to an IP address, you will
59 also need to override WEBSERVER_IP.
60
e449c13 @mjray Add configuration file helper to the installer
mjray authored
61 =cut
62
63 $myhost = hostname();
64 $mydomain = $myhost;
65 $mydomain =~ s/^.*?\.//;
cecd7ef @mjray BUGFIX: set all configuration keys - die terminated the hash
mjray authored
66 # This is set here to rescue systems with broken DNS
67 $myip = $ENV{'WEBSERVER_IP'} || inet_ntoa(scalar gethostbyname($myhost||'localhost')) || die "Cannot get our own IP address: DNS fault?";
d1f9665 Now using install_base instead of prefix
Chris Cormack authored
68 $prefix = $ENV{'INSTALL_BASE'} || "/usr";
e449c13 @mjray Add configuration file helper to the installer
mjray authored
69
70 # These are our configuration guesses
71 # Keys were extracted by
72 # <grep -o '__.*__' etc/* | cut -f2 -d: | sort -u | sed -e 's/^/ "/;s/$/" => "",/'
73 %configuration = (
243ec54 @mjray Move many files to more FHS-like paths
mjray authored
74 "__LOG_DIR__" => "/var/log",
bc4699c Changes to add dbms type and port & rename db vars for multi-dbms
Chris Nighswonger authored
75 "__DB_TYPE__" => "mysql",
76 "__DB_NAME__" => "koha",
77 "__DB_HOST__" => $myhost,
78 "__DB_PORT__" => "3306",
79 "__DB_USER__" => "kohaadmin",
80 "__DB_PASS__" => "katikoan",
28695e9 @mjray Add missing auto_install features to new installer
mjray authored
81 "__WEBMASTER_EMAIL__" => 'webmaster@'.$mydomain,
e449c13 @mjray Add configuration file helper to the installer
mjray authored
82 "__WEBSERVER_DOMAIN__" => $mydomain,
83 "__WEBSERVER_HOST__" => $myhost,
cecd7ef @mjray BUGFIX: set all configuration keys - die terminated the hash
mjray authored
84 "__WEBSERVER_IP__" => $myip,
85 "__WEBSERVER_PORT__" => "80",
86 "__WEBSERVER_PORT_LIBRARIAN__" => "8080",
bbd043f adding three new variables for installation:
Joshua Ferraro authored
87 "__ZEBRA_SRU_HOST__" => $myhost,
88 "__ZEBRA_SRU_BIBLIOS_PORT__" => "9998",
89 "__ZEBRA_SRU_AUTHORITIES_PORT__" => "9999",
e6ee69b various installer changes
Galen Charlton authored
90 "__KOHA_USER__" => "koha",
91 "__KOHA_GROUP__" => "koha",
e449c13 @mjray Add configuration file helper to the installer
mjray authored
92 "__ZEBRA_PASS__" => "zebrastripes",
93 "__ZEBRA_USER__" => "kohauser",
5befdd2 installer (part 2): more work
Galen Charlton authored
94 '__INTRANET_CGI_DIR__' => "$prefix/intranet/cgi-bin",
95 '__INTRANET_TMPL_DIR__' => "$prefix/intranet/templates",
96 '__INTRANET_WWW_DIR__' => "$prefix/intranet/www",
97 '__OPAC_CGI_DIR__' => "$prefix/opac/cgi-bin",
98 '__OPAC_TMPL_DIR__' => "$prefix/opac/templates",
99 '__OPAC_WWW_DIR__' => "$prefix/opac/www",
100 '__PERL_MODULE_DIR__' => ($ENV{'INSTALLSITELIB'} || sprintf($prefix."/lib/perl5/site_perl/%vd",$^V))."/koha",
101 '__KOHA_CONF_DIR__' => "$prefix/etc/koha",
102 '__ZEBRA_CONF_DIR__' => "$prefix/etc/koha/zebradb",
1b71360 installer: various changes
Galen Charlton authored
103 '__MISC_DIR__' => "$prefix/misc",
5befdd2 installer (part 2): more work
Galen Charlton authored
104 '__SCRIPT_DIR__' => "$prefix/bin",
105 '__MAN_DIR__' => "$prefix/man",
106 '__DOC_DIR__' => "$prefix/doc",
107 '__ZEBRA_LOCK_DIR__' => "$prefix/var/lock/zebradb",
108 '__ZEBRA_DATA_DIR__' => "$prefix/var/lib/zebradb",
109 '__ZEBRA_RUN_DIR__' => "$prefix/var/run/zebradb",
0f5fa1b installer: further moves of zebra configuration files
Galen Charlton authored
110 '__ZEBRA_MARC_FORMAT__' => 'marc21',
111 '__ZEBRA_LANGUAGE__' => 'en',
1c0401e authorities - enabled DOM indexing
Galen Charlton authored
112 '__ZEBRA_AUTH_CFG__' => 'zebra-authorities.cfg',
113 '__AUTH_RETRIEVAL_CFG__' => 'retrieval-info-auth-grs1.xml',
e449c13 @mjray Add configuration file helper to the installer
mjray authored
114 );
115
116 # Override configuration from the environment
117 foreach $key (keys %configuration) {
118 if (defined($ENV{$key})) {
119 $configuration{$key} = $ENV{$key};
120 }
121 }
122
123 $fname = $ARGV[0];
124 $file = read_file($fname);
1df0f05 installer: make rewrite-config.PL change only defined parameters
Galen Charlton authored
125 $file =~ s/__.*?__/exists $configuration{$&} ? $configuration{$&} : $&/seg;
e6ee69b various installer changes
Galen Charlton authored
126
127 # At this point, file is in 'blib' and by default
128 # has mode a-w. Therefore, must change permission
129 # to make it writable. Note that stat and chmod
130 # (the Perl functions) should work on Win32
131 my $old_perm;
132 $old_perm = (stat $fname)[2] & 07777;
133 my $new_perm = $old_perm | 0200;
134 chmod $new_perm, $fname;
135
e449c13 @mjray Add configuration file helper to the installer
mjray authored
136 open(OUTPUT,">$fname") || die "Can't open $fname for write: $!";
137 print OUTPUT $file;
138 close(OUTPUT);
139
e6ee69b various installer changes
Galen Charlton authored
140 chmod $old_perm, $fname;
141
e449c13 @mjray Add configuration file helper to the installer
mjray authored
142 # Idea taken from perlfaq5
143 sub read_file($) {
144 local(*INPUT,$/);
145 open(INPUT,$_[0]) || die "Can't open $_[0] for read";
146 my $file = <INPUT>;
147 return $file;
148 }
149
150 __END__
151
152
153 =head1 SEE ALSO
154
155 Makefile.PL, ExtUtils::MakeMaker(3)
156
157 =head1 AUTHOR
158
159 MJ Ray mjr at phonecoop.coop
160
161 =cut
162
Something went wrong with that request. Please try again.