Remove build.properties and replace it with a "local.cfg" which can o…

…verride configs as needed.

dspace/config/dspace.cfg

@@ -18,35 +18,47 @@
 #------------------------------------------------------------------#
 # These configs are used by underlying DSpace API, and are         #
 # therefore applicable to all interfaces                           #
-# Local, simple configuration should be made in build.properties   #
+# Local configuration should be made in local.cfg (where possible) #
 # Global or more complex configuration can be hardcoded here       #
 #------------------------------------------------------------------#
 ##### Basic information ######
 
 # DSpace installation directory
-dspace.dir = ${dspace.install.dir}
+# Windows note: Please remember to use forward slashes for all paths (e.g. C:/dspace)
+dspace.dir = /dspace
 
 # DSpace host name - should match base URL.  Do not include port number.
-dspace.hostname = ${dspace.hostname}
+dspace.hostname = localhost
 
 # DSpace base host URL.  Include port number etc.
-dspace.baseUrl = ${dspace.baseUrl}
+dspace.baseUrl = http://localhost:8080
 
-# DSpace base URL.  Include port number etc., but NOT trailing slash
-# Change to xmlui if you wish to use the xmlui as the default, or remove
-# "/jspui" and set webapp of your choice as the "ROOT" webapp in
-# the servlet engine.
-dspace.url = ${dspace.url}
+# The user interface you will be using for DSpace. Common usage is either xmlui or jspui
+dspace.ui = xmlui
+
+# Full link your end users will use to access DSpace. In most cases, this will be the baseurl followed by
+# the context path to the UI you are using.
+#
+# Alternatively, you can use a url redirect or deploy the web application under the servlet container root.
+# In this case, make sure to remove the /${dspace.ui} from the dspace.url property.
+dspace.url = ${dspace.baseUrl}/${dspace.ui}
 
 # Optional: DSpace URL for mobile access
 # This 
 #dspace.mobileUrl = http://mobile.example.com
 
 # Name of the site
-dspace.name = ${dspace.name}
+dspace.name = DSpace at My University
 
 # Default language for metadata values
-default.language = ${default.language}
+default.language = en_US
+
+# Solr server/webapp.
+# DSpace uses Solr for all search/browse capability (and for usage statistics by default).
+# The included 'solr' webapp MUST be deployed to Tomcat for DSpace to function.
+# Usually it will be available via port 8080 and the 'solr' context path. But,
+# But, you may need to modify this if you are running DSpace on a custom port, etc.
+solr.server = http://localhost:8080/solr
 
 ##### Database settings #####
 # The DSpace database is now configured via Hibernate (http://hibernate.org)
@@ -57,35 +69,38 @@ default.language = ${default.language}
 
 ##### Email settings ######
 
-# SMTP mail server
-mail.server = ${mail.server}
+# SMTP mail server (allows DSpace to send email notifications)
+mail.server = smtp.example.com
 
 # SMTP mail server authentication username and password (if required)
-mail.server.username = ${mail.server.username}
-mail.server.password = ${mail.server.password}
+mail.server.username =
+mail.server.password =
 
 # SMTP mail server alternate port (defaults to 25)
-mail.server.port = ${mail.server.port}
+mail.server.port = 25
 
 # From address for mail
-mail.from.address = ${mail.from.address}
+# All mail from the DSpace site will use this 'from' address
+mail.from.address = [email protected]
 
 # Name of a pre-configured Session object to be fetched from a directory.
 # This overrides the Session settings above.  If none can be found, then DSpace
 # will use the above settings to create a Session.
 #mail.session.name = Session
 
+# When feedback is submitted via the Feedback form, it is sent to this address
 # Currently limited to one recipient!
-feedback.recipient = ${mail.feedback.recipient}
+feedback.recipient = [email protected]
 
 # General site administration (Webmaster) e-mail
-mail.admin = ${mail.admin}
+# System notifications/reports and other sysadmin emails are sent to this address
+mail.admin = [email protected]
 
-# Recipient for server errors and alerts
-alert.recipient = ${mail.alert.recipient}
+# Recipient for server errors and alerts (defaults to mail.admin)
+alert.recipient = ${mail.admin}
 
-# Recipient for new user registration emails
-registration.notify = ${mail.registration.notify}
+# Recipient for new user registration emails (defaults to unspecified)
+#registration.notify =
 
 # Set the default mail character set. This may be overridden by providing a line
 # inside the email template "charset: <encoding>", otherwise this default is used.
@@ -233,10 +248,11 @@ search.index.12 = language:dc.language.iso
 # in JSPUI's 'identifier' message on item record pages for existing items.
 #
 # If omitted, the canonical URL prefix will be http://hdl.handle.net/
-handle.canonical.prefix = ${handle.canonical.prefix}
+handle.canonical.prefix = http://hdl.handle.net/
 
 # CNRI Handle prefix
-handle.prefix = ${handle.prefix}
+# (Defaults to a dummy/fake prefix of 123456789)
+handle.prefix = 123456789
 
 # Directory for installing Handle server files
 handle.dir = ${dspace.dir}/handle-server
@@ -319,10 +335,10 @@ handle.dir = ${dspace.dir}/handle-server
 #### Proxy Settings ######
 # uncomment and specify both properties if proxy server required
 # proxy server for external http requests - use regular hostname without port number
-http.proxy.host = ${http.proxy.host}
+http.proxy.host =
 
 # port number of proxy server
-http.proxy.port = ${http.proxy.port}
+http.proxy.port =
 
 
 #### Media Filter / Format Filter plugins (through PluginService) ####

dspace/src/main/assembly/release.xml

@@ -35,7 +35,7 @@
             <include>LICENSE*</include>
             <include>NOTICE</include>
             <include>README</include>
-            <include>build.properties</include>
+            <include>local.cfg</include>
             <include>pom.xml</include>
          </includes>
          <!-- Exclude any target directories or dot files -->

build.properties → local.cfg

@@ -1,28 +1,34 @@
-# DSpace build.properties
-# This file should be customised to suit your build environment.
-# Note that not all configuration is handled here, only the most common
-# properties that tend to differ between build environments. 
-# For adjusting global settings or more complex settings, edit the relevant config file.
+# local.cfg for DSpace
 #
-# IMPORTANT: Do not remove or comment out settings in build.properties
-# When you edit the "build.properties" file (or a custom *.properties file),
-# take care not to remove or comment out any settings. Doing so, may cause
-# your final "dspace.cfg" file to be misconfigured with regards to that
-# particular setting.  Instead, if you wish to remove/disable a particular
-# setting, just clear out its value.  For example, if you don't want to be
-# notified of new user registrations, ensure the "mail.registration.notify"
-# setting has no value, e.g. "mail.registration.notify="
+# Any configurations added to this file will automatically OVERRIDE configurations
+# of the same name in any of the DSpace *.cfg files.
+#
+# While some sample configurations are provided below, you may also copy
+# ANY configuration from ANY DSpace *.cfg file into this "local.cfg" to OVERRIDE
+# its default value. This includes any of these files:
+#    * [dspace]/config/dspace.cfg
+#    * Or any configuration file that is loaded into 'dspace.cfg'
+#     (see "include =" settings near the end of dspace.cfg for full list)
+#
+# You may also specify additional configuration files to load by simply adding:
+# include = [file-path]
+# The [file-path] should be relative to the [dspace]/config/ folder, e.g.
+# include = modules/authentication-ldap.cfg
+#
+# Any commented out settings in this file are simply ignored. A configuration
+# will only override another configuration if it has the EXACT SAME key/name.
+# For example, including "dspace.dir" in this local.cfg will override the
+# default value of "dspace.dir" in the dspace.cfg file.
 #
 
 ##########################
-# SERVER CONFIGURATION #
+# SERVER CONFIGURATION   #
 ##########################
 
-# DSpace installation directory. This is the location where you want
-# to install DSpace. NOTE: this value will be copied over to the
-# "dspace.dir" setting in the final "dspace.cfg" file. It can be
-# modified later on in your "dspace.cfg", if needed.
-dspace.install.dir=/dspace
+# DSpace installation directory.
+# This is the location where you want to install DSpace.
+# Windows note: Please remember to use forward slashes for all paths (e.g. C:/dspace)
+dspace.dir=/dspace
 
 # DSpace host name - should match base URL.  Do not include port number
 dspace.hostname = localhost
@@ -38,16 +44,20 @@ dspace.ui = xmlui
 #
 # Alternatively, you can use a url redirect or deploy the web application under the servlet container root.
 # In this case, make sure to remove the /${dspace.ui} from the dspace.url property.
-dspace.url = ${dspace.baseUrl}/${dspace.ui}
+#dspace.url = ${dspace.baseUrl}/${dspace.ui}
 
 # Name of the site
 dspace.name = DSpace at My University
 
-# Solr server
-solr.server=http://localhost:8080/solr
-
 # Default language for metadata values
-default.language = en_US
+#default.language = en_US
+
+# Solr server/webapp.
+# DSpace uses Solr for all search/browse capability (and for usage statistics by default).
+# The included 'solr' webapp MUST be deployed to Tomcat for DSpace to function.
+# Usually it will be available via port 8080 and the 'solr' context path. But,
+# But, you may need to modify this if you are running DSpace on a custom port, etc.
+solr.server = http://localhost:8080/solr
 
 ##########################
 # DATABASE CONFIGURATION #
@@ -71,7 +81,6 @@ db.schema = public
 # The schema in oracle is the usually the user name
 #db.schema = dspace
 
-
 # Maximum number of DB connections in pool
 db.maxconnections = 30
 
@@ -86,34 +95,32 @@ db.maxidle = -1
 # EMAIL CONFIGURATION #
 #######################
 
-# SMTP mail server
-mail.server = smtp.example.com
+# SMTP mail server (allows DSpace to send email notifications)
+#mail.server = smtp.example.com
 
 # SMTP mail server authentication username and password (if required)
-# mail.server.username = myusername
-# mail.server.password = mypassword
-mail.server.username=
-mail.server.password=
+#mail.server.username = myusername
+#mail.server.password = mypassword
 
 # SMTP mail server alternate port (defaults to 25)
-mail.server.port = 25
+#mail.server.port = 25
 
 # From address for mail
-mail.from.address = [email protected]
+# All mail from the DSpace site will use this 'from' address
+#mail.from.address = [email protected]
 
+# When feedback is submitted via the Feedback form, it is sent to this address
 # Currently limited to one recipient!
-mail.feedback.recipient = [email protected]
+#feedback.recipient = [email protected]
 
 # General site administration (Webmaster) e-mail
-mail.admin = [email protected]
+#mail.admin = [email protected]
 
-# Recipient for server errors and alerts
-#mail.alert.recipient = email-address-here
-mail.alert.recipient=
+# Recipient for server errors and alerts (defaults to mail.admin)
+#alert.recipient = ${mail.admin}
 
-# Recipient for new user registration emails
-#mail.registration.notify = email-address-here
-mail.registration.notify=
+# Recipient for new user registration emails (defaults to unspecified)
+#registration.notify =
 
 
 ########################
@@ -137,20 +144,21 @@ mail.registration.notify=
 # in JSPUI's 'identifier' message on item record pages for existing items.
 #
 # If omitted, the canonical URL prefix will be http://hdl.handle.net/
-handle.canonical.prefix = http://hdl.handle.net/
+#handle.canonical.prefix = http://hdl.handle.net/
 
 # CNRI Handle prefix
-handle.prefix = 123456789
+# (Defaults to a dummy/fake prefix of 123456789)
+#handle.prefix = 123456789
 
 #######################
 # PROXY CONFIGURATION #
 #######################
 # uncomment and specify both properties if proxy server required
 # proxy server for external http requests - use regular hostname without port number
-http.proxy.host =
+#http.proxy.host =
 
 # port number of proxy server
-http.proxy.port =
+#http.proxy.port =
 
 #####################
 # LOGLEVEL SETTINGS #