Merge pull request #59 from robintaylor/DS-1208

[DS-1208] - reinstate various comments in dspace.cfg

dspace/config/dspace.cfg

@@ -23,37 +23,90 @@
 #------------------------------------------------------------------#
 ##### Basic information ######
 
+# DSpace installation directory
 dspace.dir = ${dspace.dir}
+
+# DSpace host name - should match base URL.  Do not include port number.
 dspace.hostname = ${dspace.hostname}
+
+# DSpace base host URL.  Include port number etc.
 dspace.baseUrl = ${dspace.baseUrl}
+
+# 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.baseUrl}/xmlui
+
+# Name of the site
 dspace.name = ${dspace.name}
+
+# Default language for metadata values
 default.language = ${default.language}
 
 ##### Database settings #####
 
+# Database name ("oracle", or "postgres")
 db.name = ${db.name}
+
+# URL for connecting to database
 db.url = ${db.url}
+
+# JDBC Driver
 db.driver = ${db.driver}
+
+# Database username and password
 db.username = ${db.username}
 db.password = ${db.password}
+
+# Schema name - if your database contains multiple schemas, you can avoid problems with
+# retrieving the definitions of duplicate object names by specifying
+# the schema name here that is used for DSpace by uncommenting the following entry
 db.schema = ${db.schema}
+
+# Connection pool parameters
+
+# Maximum number of DB connections in pool
 db.maxconnections = ${db.maxconnections}
+
+# Maximum time to wait before giving up if all connections in pool are busy (milliseconds)
 db.maxwait = ${db.maxwait}
+
+# Maximum number of idle connections in pool (-1 = unlimited)
 db.maxidle = ${db.maxidle}
+
+# Determine if prepared statement should be cached. (default is true)
 db.statementpool = ${db.statementpool}
+
+# Specify a name for the connection pool (useful if you have multiple applications sharing Tomcat's dbcp)
+# If not specified, defaults to 'dspacepool'
 db.poolname = ${db.poolname}
 
 ##### Email settings ######
 
+# SMTP mail server
 mail.server = ${mail.server}
+
+# SMTP mail server authentication username and password (if required)
 mail.server.username = ${mail.server.username}
 mail.server.password = ${mail.server.password}
+
+# SMTP mail server alternate port (defaults to 25)
 mail.server.port = ${mail.server.port}
+
+# From address for mail
 mail.from.address = ${mail.from.address}
+
+# Currently limited to one recipient!
 feedback.recipient = ${mail.feedback.recipient}
+
+# General site administration (Webmaster) e-mail
 mail.admin = ${mail.admin}
+
+# Recipient for server errors and alerts
 alert.recipient = ${mail.alert.recipient}
+
+# Recipient for new user registration emails
 registration.notify = ${mail.registration.notify}
 
 # Set the default mail character set. This may be overridden by providing a line
@@ -226,7 +279,26 @@ search.index.12 = language:dc.language.iso
 
 ##### Handle settings ######
 
+# Canonical Handle URL prefix
+#
+# By default, DSpace is configured to use http://hdl.handle.net/
+# as the canonical URL prefix when generating dc.identifier.uri
+# during submission, and in the 'identifier' displayed in JSPUI
+# item record pages.
+#
+# If you do not subscribe to CNRI's handle service, you can change this
+# to match the persistent URL service you use, or you can force DSpace
+# to use your site's URL, eg.
+#handle.canonical.prefix = ${dspace.url}/handle/
+#
+# Note that this will not alter dc.identifer.uri metadata for existing
+# items (only for subsequent submissions), but it will alter the URL
+# 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}
+
+# CNRI Handle prefix
 handle.prefix = ${handle.prefix}
 
 # Directory for installing Handle server files
@@ -299,7 +371,11 @@ 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}
+
+# port number of proxy server
 http.proxy.port = ${http.proxy.port}