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

#### properties file for Greenstone3 building using ANT. See the README for more 
#### information

## Reverse Proxy Settings
#
# If using a different web server, such as Apache2, configured to be a reverse-proxy web server
# sitting in front of Tomcat, then uncomment the following and set accordingly
#
# It is unlikely that you will need to explicity set 'revproxy.port', given the main point
# of a reverse-proxy web server is to provide a cleaner (hardened) URL for users to access
# It is included for completeness.
#
# If you do not text 'revproxy.context' then it will default to 'greenstone3.context'
#revproxy.protocol=https
#revproxy.server=<mydomain.org>
##revproxy.port=8080
##revproxy.context=/greenstone3

## Tomcat installation

# Allow/disallow symlinks inside the web application
# Note however, that a value of true for this property will nevertheless be disregarded on Windows,
# because it has a case insensitive filesystem where a true setting would have had security
# implications otherwise.
# Beware that if you are working on any other operating system with a case insensitive filesystem,
# you should ensure this value remains set to false for security reasons.
tomcat.user.allowLinking=false

# Specify your Google Client API Id here, and uncomment if you want Greenstone3 to allow users
#   signin on through Google Signin
# Note: You also need to specify the Google Client Id in web/WEB-INF/servlet.xml as
//  an <init-param></init-param>
#tomcat.googlesigninJDBCRealm.clientid=????....????.apps.googleusercontent.com

# Set this to the internet/intranet name of the machine that Tomcat is/will be 
# run on. localhost is fine for accessing the server from the local machine, 
# but not remotely
tomcat.server=localhost

# If your machine's IP doesn't resolve to any of the usual local IP addresses,
# and instead has any specific IP(s) associated with it, set or add them here within
# the round brackets, with a vertical bar to connect them with the rest of the line
tomcat.server.IPregex=(127\\\\.\\\\d+\\\\.\\\\d+\\\\.\\\\d+|::1|0:0:0:0:0:0:0:1(%\\\\d)?)

# server.protocols must contain 'http' or 'https' or both (in order of preference) separated by commas
# These specify the protocols you want your Digital Library (DL) to be accessible over. 
# The FIRST ONE in the list will be the default.
# NOTE: For https support, you will additionally also need to
# - assign a password to keystore.pass below
# - ensure an unused and valid port number is assigned to tomcat.port.https below
# - set tomcat.server above to the primary domain name of your DL, and
# - run the 'ant setup-https-cert' target to get an official security certificate issued (for which
# you may need admin/sudo permissions)
server.protocols=http
#server.protocols=https
#server.protocols=https,http

# You must set a password if you turned on https support by including 'https' in server.protocols above
keystore.pass=

# Choose valid port numbers that aren't already in use for tomcat.port.https and localhost.port.http:

# If server.protocols above contains https, then your DL will (additionally) be available over https
# on the port you assign for tomcat.port.https when you make your DL public.
# But if server.protocols does not contain https, then tomcat.port.https will remain unused.
tomcat.port.https=8443

# When the server is running, http will always be available locally at 127.0.0.1 at localhost.port.http
# If server.protocols above includes http, then your DL will additionally be made public over http
# (on the hostname denoted by tomcat.server at the port number denoted by localhost.port.http)
localhost.port.http=8383

# The local server host address. Since 127.0.0.1 is safer than localhost,
# leave this property as-is unless your local loopback address is not 127.0.0.1.
# See also https://letsencrypt.org/docs/certificates-for-localhost/
localhost.server.http=127.0.0.1

# Tomcat's shutdown port - this may need to be changed if you are running two or more Tomcats
tomcat.shutdown.port=8305
tomcat.ajp.port=8309

# If tomcat is already running, enter the path to the base directory here
tomcat.installed.path=
# uncomment the following if you have moved the greenstone3 web directory to tomcats webapps dir 
#web.home=${tomcat.installed.path}/webapps/greenstone3

# The context name of your GS3 digital library. By default this will be "greenstone3". Ensure this has a value.
greenstone.context=greenstone3
# The servlet name (url path) for your default servlet - change this if you are not using 'library' as your servlet name - used for GLI
greenstone.default.servlet=/library

# solr generally lives off /solr from the base greenstone URL
solr.context=solr

# oaiserver servlet names - a comma separated list
oai.servlets=oaiserver

## If creating a GS3 set up with a dispersed web folder ("web-dispersed" GS3), with GS3 in a read-only location, then 
## it will need a distinct user web folder for content (sites and collections), and need to run tomcat from TMP.
## You need to configure 4 properties to get a "web-dispersed" GS3 to work on windows:
## - set web.home above to the writable location where collections and sites should be created (use forward slashes)
## - uncomment using.user.web below and set to true, 
## To make tomcat run from TMP folder (a writable location):
## - set gsdl3home.isreadonly to true and 
## - set gsdl3.writablehome to ${java.io.tmpdir}/greenstone/web (use forward slashes)
# using.user.web=true

# While the default derby networked server portnumber is 1527, for Greenstone3 we choose to
# move this up into the '83' range
derby.server.port=8327
# The following is best left as it is, except if 'localhost' doesn't work on your machine,
# then try setting it to 127.0.0.1 or its IPv6 equivalent 0:0:0:0:0:0:0:1
derby.server=localhost

## Collection building options
# uncomment if you don't want to have collection building enabled
#disable.collection.building=true
#
# uncomment (and edit) if you want to control where perl is found
#perl.path=/usr/bin

## Greenstone 3 server program options
# does running the server automatically start up Tomcat and a browser
server.auto.start=false
# if set to true, won't try other ports if the specified port is not available
server.keep.port=false
# whether to make the greenstone pages publicly accessible or only to this machine
server.external.access=true

##Browser setup
browser.path=

## Proxy setup - Greenstone installation will attempt to download extra packages. Set the proxy information here if you are behind a firewall.
# The proxy server name 
proxy.host=
# The proxy server port
proxy.port=
# A user name to use when talking to the proxy server (optional, will prompt if not entered here)
proxy.user=
# A password to use when talking to the proxy server (optional, will prompt if not entered here)
proxy.password=

## java compilation properties - for javac
# Should compilation include the debug option?
compile.debug=true
# Should compilation include the deprecation option?
compile.deprecation=true
# Should compilation include the optimize option?
compile.optimize=true

# Properties that control cross-compiling
compile.cross        = false
#cross.os             = windows
#cross.host           = i686-w64-mingw32
#cross.build          = i686-pc-linux-gnu
#cross.configure.extraargs =

#cross.os             = android
#cross.host           = arm-linux-androideabi
#cross.build          = i686-pc-linux-gnu
#cross.configure.extraargs = gl_cv_header_working_stdint_h=yes


# Control whether or not JNI bindings are used
#   e.g. MG, MG++ and GDBM and the like
# Setting this false means these components are not available to the install
# The expectation is that collections will be build from 100% Java components:
#   e.g Lucene and JDBM
# 
with.jni=true

# Controls whether or not we want wv-ware compiled up for processing
# Word docs. If setting to false, then you might want to add in the
# OpenOffice and Tika gs2 extensions
with.wvware=true

## Controls whether or not we want GLI and GEMS to be checked out and compiled
with.gli.and.gems=true

## Control if compilation of gs2 is static or not. Used, for example, for distributions
# Same issue as 'with.jni' for how this gets used in ant 1.7.1 and before
#compile.static=true

# A flag used by the release-kit to compile with gnomelib
# (Previously this flag was called use.support.lib but got conflated with
# the property checkout.gnomelib.ext below)
#use.gnomelib.ext=true

# Adjust accordingly:
#   gnomelib typically needed to compile up wvWare (on by default)
#   imagemagick used to generate thumbnai images etc (off by default, as may be already installed)
checkout.gnomelib.ext=true
checkout.imagemagick.ext=false

# By default, GS3 will check out the pdfbox extension from SVN
checkout.pdfbox.ext=true

# The following two properties are automatically overridden by gs3-server
# when running off a read-only medium such as a DVD ...
#
# The 'writable' home default is to be the same location as gsdl3.home
gsdl3home.isreadonly=false
gsdl3.writablehome=${basedir}/web

# ... alternative the above can be changed to
#
#  gsdl3home.isreadonly=true
#  gsdl3.writablehome=${java.io.tmpdir}/greenstone/web
#
# ... or else provided on the command line, e.g.:
#   ant -Dgsdl3home.isreadonly=true gsdl3.writablehome=/tmp/greenstone/web start

## windows c++ compilation
# The following property does not help in build.xml. 
# The user needs to run Visual Studio's vcvars32.bat script from the
# MSDOS prompt before compiling Greenstone3 (before "ant prepare install")
#compile.windows.c++.setup=C:/Program Files/Microsoft Visual Studio/VC98/Bin/VCVARS32.BAT

##Flax stuff##
##uncomment if you want to install flax
#install.flax=true
flax.checkout.path=${flax.svn.root}/trunk/flaxmain

##These need to be uncommented if using Fedora and Fedora GSearch with Greenstone's tomcat
fedora.home=#${basedir}/ext/fedora3
#fedora.maxpermsize=-XX:MaxPermSize=128m
#fedora.password=pounamu
#index.writelock.timeout=10000

##Web services related constants##
base.webservice.name=SOAPServer
##listing and description of all the web services deployable on GS3##
web.services.list=${base.webservice.name} for Greenstone3's core web services, QBR${base.webservice.name} for Query, Browse and Retrieve services