source: main/trunk/greenstone3/build.properties.svn@ 32471

Last change on this file since 32471 was 32432, checked in by ak19, 6 years ago
  1. Since there's a chance that 127.0.0.1 isn't always the loopback address or may not always work, we allow this to be specified by the new property localhost.server.http in build.properties. Updating recently commited code that is affected by this and where I had been hardcoding 127.0.0.1. 2. Fixing up the port and now the server host name used by the solr extension: these should be the correct property names, which are localhost.port.http and the new localhost.server.http instead of tomcat.server and the default port for the default protocol, since all GS3 internal communications with solr are done through the local HTTP url, whatever the public URL (with default protocol, matching port and server name) might be. I also updated the get-solr-servlet-url target in build.xml to use the local http base URL (see point 3), so that solr building will work correctly. 3. build.xml now has 2 new targets, one to get the local http base URL and one to get the local http default servlet URL. Both also use the new localhost.server.http property, besides the recently introduced localhost.port.http property. 4. Now the default behaviour of util.pm::get_full_greenstone_url_prefix() is to call the new get-local-http-servlet-url ant target, since only activate.pl's servercontrol.pm helper module uses it. If you want util.pm::get_full_greenstone_url_prefix() to return the non-local (public) servlet URL, pass in 1 (true) for the new 3rd parameter. The important decision here is that activate will use the internal (i.e. local http) greenstone servlet URL to issue pinging and (de)activating commands, since localhost (specifically 127.0.0.1) over http is now always available and because a domain named server over https will create complications to do with certification checks by wget, when wget gets run by activate.pl. Alternatively, activate.pl/servercontrol.pm could run wget with the no-cert-checking flag or we could make wget check the GS3 https certificate if one exists. But all that is convoluted and unnecessary: we've so far always worked with http, and usually with localhost over the httpport, and activate.pl so far has worked well with this, so have some confidence that using the local http URL internally should still work, even if the default GS3 URL has been set up to be a public (https) URL.
File size: 8.0 KB
Line 
1#### properties file for Greenstone3 building using ANT. See the README for more
2#### information
3
4## Tomcat installation
5
6# Set this to the internet/intranet name of the machine that Tomcat is/will be
7# run on. localhost is fine for accessing the server from the local machine,
8# but not remotely
9tomcat.server=localhost
10
11# server.protocols must contain 'http' or 'https' or both (in order of preference) separated by commas
12# These specify the protocols you want your Digital Library (DL) to be accessible over.
13# The FIRST ONE in the list will be the default.
14# NOTE: For https support, you will additionally also need to
15# - assign a password to keystore.pass below
16# - ensure an unused and valid port number is assigned to tomcat.port.https below
17# - set tomcat.server above to the primary domain name of your DL, and
18# - run the 'ant setup-https-cert' target to get an official security certificate issued (for which
19# you may need admin/sudo permissions)
20server.protocols=http
21#server.protocols=https
22#server.protocols=https,http
23
24# You must set a password if you turned on https support by including 'https' in server.protocols above
25keystore.pass=
26
27# Choose valid port numbers that aren't already in use for tomcat.port.https and localhost.port.http:
28
29# If server.protocols above contains https, then your DL will (additionally) be available over https
30# on the port you assign for tomcat.port.https when you make your DL public.
31# But if server.protocols does not contain https, then tomcat.port.https will remain unused.
32tomcat.port.https=8443
33
34# When the server is running, http will always be available locally at 127.0.0.1 at localhost.port.http
35# If server.protocols above includes http, then your DL will additionally be made public over http
36# (on the hostname denoted by tomcat.server at the port number denoted by localhost.port.http)
37localhost.port.http=8383
38
39# The local server host address. Since 127.0.0.1 is safer than localhost,
40# leave this property as-is unless your local loopback address is not 127.0.0.1.
41# See also https://letsencrypt.org/docs/certificates-for-localhost/
42localhost.server.http=127.0.0.1
43
44# Tomcat's shutdown port - this may need to be changed if you are running two or more Tomcats
45tomcat.shutdown.port=8305
46
47# If tomcat is already running, enter the path to the base directory here
48tomcat.installed.path=
49# uncomment the following if you have moved the greenstone3 web directory to tomcats webapps dir
50#web.home=${tomcat.installed.path}/webapps/greenstone3
51
52# The context name of your GS3 digital library. By default this will be "greenstone3". Ensure this has a value.
53greenstone.context=greenstone3
54
55# solr generally lives off /solr from the base greenstone URL
56solr.context=solr
57
58
59## If creating a GS3 set up with a dispersed web folder ("web-dispersed" GS3), with GS3 in a read-only location, then
60## it will need a distinct user web folder for content (sites and collections), and need to run tomcat from TMP.
61## You need to configure 4 properties to get a "web-dispersed" GS3 to work on windows:
62## - set web.home above to the writable location where collections and sites should be created (use forward slashes)
63## - uncomment using.user.web below and set to true,
64## To make tomcat run from TMP folder (a writable location):
65## - set gsdl3home.isreadonly to true and
66## - set gsdl3.writablehome to ${java.io.tmpdir}/greenstone/web (use forward slashes)
67# using.user.web=true
68
69# Default derby networked server portnumber is 1527, can change this here in case of conflict
70derby.server.port=1527
71# The following is best left as it is, except if 'localhost' doesn't work on your machine,
72# then try setting it to 127.0.0.1 or its IPv6 equivalent 0:0:0:0:0:0:0:1
73derby.server=localhost
74
75## Collection building options
76# uncomment if you don't want to have collection building enabled
77#disable.collection.building=true
78#
79# uncomment (and edit) if you want to control where perl is found
80#perl.path=/usr/bin
81
82## Greenstone 3 server program options
83# does running the server automatically start up Tomcat and a browser
84server.auto.start=false
85# if set to true, won't try other ports if the specified port is not available
86server.keep.port=false
87# default servlet to start with
88server.default.servlet=/library
89# whether to make the greenstone pages publicly accessible or only to this machine
90server.external.access=true
91
92##Browser setup
93browser.path=
94
95## Proxy setup - Greenstone installation will attempt to download extra packages. Set the proxy information here if you are behind a firewall.
96# The proxy server name
97proxy.host=
98# The proxy server port
99proxy.port=
100# A user name to use when talking to the proxy server (optional, will prompt if not entered here)
101proxy.user=
102# A password to use when talking to the proxy server (optional, will prompt if not entered here)
103proxy.password=
104
105## java compilation properties - for javac
106# Should compilation include the debug option?
107compile.debug=true
108# Should compilation include the deprecation option?
109compile.deprecation=true
110# Should compilation include the optimize option?
111compile.optimize=true
112
113# Properties that control cross-compiling
114compile.cross = false
115#cross.os = windows
116#cross.host = i686-w64-mingw32
117#cross.build = i686-pc-linux-gnu
118#cross.configure.extraargs =
119
120#cross.os = android
121#cross.host = arm-linux-androideabi
122#cross.build = i686-pc-linux-gnu
123#cross.configure.extraargs = gl_cv_header_working_stdint_h=yes
124
125
126# Control whether or not JNI bindings are used
127# e.g. MG, MG++ and GDBM and the like
128# Setting this false means these components are not available to the install
129# The expectation is that collections will be build from 100% Java components:
130# e.g Lucene and JDBM
131#
132# Ant 1.7.1 and before only test for *existence* so this needs to be commented
133# in or out to control whether jni is used or not
134with.jni=true
135
136## Controls whether or not we want GLI and GEMS to be checked out and compiled
137with.gli.and.gems=true
138
139## Control if compilation of gs2 is static or not. Used, for example, for distributions
140# Same issue as 'with.jni' for how this gets used in ant 1.7.1 and before
141#compile.static=true
142
143# A flag used by the release-kit to compile with gnomelib
144# (Previously this flag was called use.support.lib but got conflated with
145# the property checkout.gnomelib.ext below)
146#use.gnomelib.ext=true
147
148## Uncomment these lines if enabling compilation with the gnome-lib extension
149## and if compiling imagemagick
150## These extensions should be in the [gsdl3home]/gs2build/ext directory
151#checkout.gnomelib.ext=true
152#checkout.imagemagick.ext=true
153
154# By default, GS3 will check out the pdfbox extension from SVN
155checkout.pdfbox.ext=true
156
157# The following two properties are automatically overridden by gs3-server
158# when running off a read-only medium such as a DVD ...
159#
160# The 'writable' home default is to be the same location as gsdl3.home
161gsdl3home.isreadonly=false
162gsdl3.writablehome=${basedir}/web
163
164# ... alternative the above can be changed to
165#
166# gsdl3home.isreadonly=true
167# gsdl3.writablehome=${java.io.tmpdir}/greenstone/web
168#
169# ... or else provided on the command line, e.g.:
170# ant -Dgsdl3home.isreadonly=true gsdl3.writablehome=/tmp/greenstone/web start
171
172## windows c++ compilation
173# The following property does not help in build.xml.
174# The user needs to run Visual Studio's vcvars32.bat script from the
175# MSDOS prompt before compiling Greenstone3 (before "ant prepare install")
176#compile.windows.c++.setup=C:/Program Files/Microsoft Visual Studio/VC98/Bin/VCVARS32.BAT
177
178##Flax stuff##
179##uncomment if you want to install flax
180#install.flax=true
181flax.checkout.path=${flax.svn.root}/trunk/flaxmain
182
183##These need to be uncommented if using Fedora and Fedora GSearch with Greenstone's tomcat
184fedora.home=#${basedir}/ext/fedora3
185#fedora.maxpermsize=-XX:MaxPermSize=128m
186#fedora.password=pounamu
187#index.writelock.timeout=10000
188
189##Web services related constants##
190base.webservice.name=SOAPServer
191##listing and description of all the web services deployable on GS3##
192web.services.list=${base.webservice.name} for Greenstone3's core web services, QBR${base.webservice.name} for Query, Browse and Retrieve services
193
Note: See TracBrowser for help on using the repository browser.