SUNScholar/Install DSpace/S04/6.X - Revision history

Ivdl: /* Example Config */

2019-10-30T12:32:23Z

Example Config

Ivdl: /* References */

2019-10-30T12:28:37Z

References

Ivdl: /* Example Config */

2019-10-30T12:28:03Z

Example Config

Show changes

Ivdl: Created page with " '''Back to Step 4''' ==Introduction== With the release of DSpace versions => 6.X, a new way of configuring DSpace was in..."

2019-10-30T12:27:21Z

Created page with "<center> '''Back to Step 4''' </center> ==Introduction== With the release of DSpace versions => 6.X, a new way of configuring DSpace was in..."

New page

<center>
'''[[SUNScholar/Install_DSpace/S04|Back to Step 4]]'''
</center>

==Introduction==
With the release of DSpace versions => 6.X, a new way of configuring DSpace was introduced.

'''The critical core elements of the old "build.properties" file have been superseded by a "local.cfg" file.'''

The idea is to put all the custom configs in the "config" folder and use the '''local.cfg''' file for the core customisations of DSpace.
==Please Note:==
''Be careful to NOT comment out any settings, leave them as they are with blanks!!''

''Use an email address with an [[PKP/Bug_Fixes/SPF|SPF complaint domain]] for: %dspace-noreply@myu.edu%''

==Procedure==
To create the local.cfg file, copy it from the '''[https://github.com/DSpace/DSpace/blob/dspace-6.3/dspace/config/local.cfg.EXAMPLE local.cfg.EXAMPLE]''' file, by typing the following:
cp $HOME/{{Source}}/dspace/config/local.cfg.EXAMPLE $HOME/{{Source}}/dspace/config/local.cfg
And then edit the file by running the following:
nano $HOME/{{Source}}/dspace/config/local.cfg
<font color="red">'''Check the file to make sure the following critical "Server Configuration" and "Database Configuration" is correct;'''</font>
===Server Configuration===
Replace all the places with a pair of percent signs ('''%something%''') in the example below with the settings for your system.
<tab width="100%" class="wikitable" sep=comma head=top>
Description,Setting,Comments
Installation Folder,'''<big><tt>dspace.install.dir = /home/dspace</tt></big>''',[[SUNScholar/Install_Ubuntu/S03/DSpace_User|Make sure you have created the "dspace" user]].
Hostname for the repository,'''<big><tt>dspace.hostname = %scholar.sun.ac.za%</tt></big>''',[[SUNScholar/Install_Ubuntu/S03/Hostname|This is the hostname you decided to use for your repository]].
Base URL for the repository,'''<big><tt>dspace.baseUrl = %http://scholar.sun.ac.za%</tt></big>''',Make sure to remove the "8080" port reference.
Default user interface,'''<big><tt>dspace.ui = xmlui</tt></big>''',We selected the XMLUI.
The URL link used,'''<big><tt>dspace.url = ${dspace.baseUrl}</tt></big>''',Make sure to remove the "'''/${dspace.ui}'''".
The long name for the repository,'''<big><tt>dspace.name = %SUNScholar Research Repository%</tt></big>''',This is usually for the repository manager to decide.
SOLR server connection,'''<big><tt>solr.server = http://localhost/solr</tt></big>''',[[SUNScholar/Install_DSpace/S06|Make sure that you deploy the SOLR java web app correctly and make sure to remove the "8080" port reference]].
The default language,'''<big><tt>default.language = %en_ZA%</tt></big>''',[[SUNScholar/Language|Make sure to select the correct language for your region]].
</tab>
===Database Configuration===
Replace all the places with a pair of percent signs ('''%something%''') in the example below with the settings for your system.
<tab width="100%" class="wikitable" sep=comma head=top>
Description,Setting,Comments
Database driver,'''<big><tt>db.driver=org.postgresql.Driver</tt></big>''',[[SUNScholar/Prepare_Ubuntu/S06|We selected the PostgreSQL driver]].
Database connection URL,'''<big><tt>db.url=jdbc:postgresql://localhost:5432/dspace</tt></big>''',We connect locally on port 5432 to the "dspace" database.
Database credentials,'''<big><tt>db.username=%dspace%</tt></big>'''<br>'''<big><tt>db.password=%dspace%</tt></big>''',''Supply your own very secret credentials.''
</tab>

===Example Config===
Check the following example for the other settings.

Replace all the places with a pair of percent signs ('''%something%''') in the example below with the settings for your system.
<pre>
# 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.
#
# 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="
#

##########################
# 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 = /home/dspace

# DSpace host name - should match base URL. Do not include port number
dspace.hostname = %scholar.sun.ac.za%

# DSpace base host URL. Include port number etc.
dspace.baseUrl = %http://scholar.sun.ac.za%

# 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}

# Name of the site
dspace.name = %SUNScholar Research Repository%

# Solr server
solr.server = http://localhost/solr

# Default language for metadata values
default.language = %en_ZA%

##########################
# DATABASE CONFIGURATION #
##########################

# Uncomment the appropriate block below for your database.
# postgres
db.driver=org.postgresql.Driver
db.url=jdbc:postgresql://localhost:5432/dspace
db.username=%dspace%
db.password=%dspace%

# oracle
#db.driver= oracle.jdbc.OracleDriver
#db.url=jdbc:oracle:thin:@//localhost:1521/xe
#db.username=dspace
#db.password=dspace

# 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 that is used for DSpace.
# ORACLE USAGE NOTE: In Oracle, schema is equivalent to "username". This means
# specifying a "db.schema" is often unnecessary (i.e. you can leave it blank),
# UNLESS your Oracle DB Account (in db.username) has access to multiple schemas.
db.schema =

# Maximum number of DB connections in pool
db.maxconnections = 50

# Maximum time to wait before giving up if all connections in pool are busy (milliseconds)
db.maxwait = 5000

# Maximum number of idle connections in pool (-1 = unlimited)
db.maxidle = 150

# Determine if prepared statement should be cached. (default is true)
db.statementpool = true

# 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 = dspacepool

#######################
# EMAIL CONFIGURATION #
#######################

# SMTP mail server
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=

# SMTP mail server alternate port (defaults to 25)
mail.server.port = 25

# From address for mail
mail.from.address = %dspace-noreply@myu.edu%

# Currently limited to one recipient!
mail.feedback.recipient = %dspace-help@myu.edu%

# General site administration (Webmaster) e-mail
mail.admin = %dspace-help@myu.edu%

# Recipient for server errors and alerts
mail.alert.recipient = %dspace-help@myu.edu%

# Recipient for new user registration emails
mail.registration.notify = %dspace-help@myu.edu%

########################
# HANDLE CONFIGURATION #
########################

# 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 = http://hdl.handle.net/

# CNRI Handle prefix
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 =

# port number of proxy server
http.proxy.port =

#####################
# LOGLEVEL SETTINGS #
#####################
loglevel.other = INFO
# loglevel.other: Log level for other third-party tools/APIs used by DSpace
# Possible values (from most to least info): DEBUG, INFO, WARN, ERROR, FATAL
loglevel.dspace = INFO
# loglevel.dspace: Log level for all DSpace-specific code (org.dspace.*)
# Possible values (from most to least info): DEBUG, INFO, WARN, ERROR, FATAL
</pre>

Save and exit the file.

==References==
*https://wiki.duraspace.org/display/DSDOC5x/Configuration+Reference#ConfigurationReference-Thebuild.propertiesConfigurationPropertiesFile
*https://github.com/DSpace/DSpace/blob/dspace-5_x/build.properties
*https://github.com/DSpace/DSpace/blob/dspace-5_x/dspace/config/dspace.cfg

[[Category:Installation]]

@@ Line 77: / Line 77: @@
 # 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.dir=/home/dspace
 # DSpace host name - should match base URL.  Do not include port number
-dspace.hostname = localhost
+dspace.hostname = %scholar.sun.ac.za%
 # DSpace base host URL.  Include port number etc.
-dspace.baseUrl = http://localhost:8080
+dspace.baseUrl = %http://scholar.sun.ac.za%
 # The user interface you will be using for DSpace. Common usage is either xmlui or jspui
@@ Line 96: / Line 96: @@
 # Name of the site
-dspace.name = DSpace at My University
+dspace.name = %SUNScholar Research Repository%
 # assetstore.dir, look at DSPACE/config/spring/api/bitstore.xml for more options
@@ Line 134: / Line 134: @@
 # Database username and password
-db.username = dspace
+db.username = %dspace%
-db.password = dspace
+db.password = %dspace%
 # Database Schema name
@@ Line 146: / Line 146: @@
 # Maximum number of DB connections in pool (default = 30)
-#db.maxconnections = 30
+db.maxconnections = 50
 # Maximum time to wait before giving up if all connections in pool are busy (milliseconds)
 # (default = 5000ms or 5 seconds)
-#db.maxwait = 5000
+db.maxwait = 5000
 # Maximum number of idle connections in pool (-1 = unlimited)
 # (default = 10)
-#db.maxidle = 10
+db.maxidle = 150
@@ Line 162: / Line 162: @@
 # SMTP mail server (allows DSpace to send email notifications)
-#mail.server = smtp.example.com
+#mail.server = %smtp.example.com%
 # SMTP mail server authentication username and password (if required)
-#mail.server.username = myusername
+mail.server.username=
-#mail.server.password = mypassword
+mail.server.password=
 # SMTP mail server alternate port (defaults to 25)
-#mail.server.port = 25
+mail.server.port = 25
 # From address for mail
 # All mail from the DSpace site will use this 'from' address
-#mail.from.address = dspace-noreply@myu.edu
+mail.from.address = %dspace-noreply@myu.edu%
 # When feedback is submitted via the Feedback form, it is sent to this address
 # Currently limited to one recipient!
-#feedback.recipient = dspace-help@myu.edu
+feedback.recipient = %dspace-help@myu.edu%
 # General site administration (Webmaster) e-mail
-#mail.admin = dspace-help@myu.edu
+mail.admin = %dspace-help@myu.edu%
 # Recipient for server errors and alerts (defaults to mail.admin)
-#alert.recipient = ${mail.admin}
+alert.recipient = %dspace-help@myu.edu%
 # Recipient for new user registration emails (defaults to unspecified)
-#registration.notify =
+registration.notify = %dspace-help@myu.edu%
@@ Line 212: / Line 212: @@
 # CNRI Handle prefix
 # (Defaults to a dummy/fake prefix of 123456789)
-#handle.prefix = 123456789
+handle.prefix = %123456789%
 #######################
@@ Line 223: / Line 223: @@
 # port number of proxy server
 #http.proxy.port =
 </pre>

@@ Line 258: / Line 258: @@
 ==References==
-*https://wiki.duraspace.org/display/DSDOC5x/Configuration+Reference#ConfigurationReference-Thebuild.propertiesConfigurationPropertiesFile
+*https://wiki.duraspace.org/display/DSDOC6x/Installing+DSpace#InstallingDSpace-Installation
-*https://github.com/DSpace/DSpace/blob/dspace-5_x/build.properties
+*https://github.com/DSpace/DSpace/blob/dspace-6.3/dspace/config/local.cfg.EXAMPLE
 [[Category:Installation]]