SUNScholar/Install DSpace/S04/6.X

Back to Step 4

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 SPF complaint domain for: %dspace-noreply@myu.edu%

Procedure

To create the local.cfg file, copy it from the 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

Check the file to make sure the following critical "Server Configuration" and "Database Configuration" is correct;

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,dspace.install.dir = /home/dspace,Make sure you have created the "dspace" user. Hostname for the repository,dspace.hostname = %scholar.sun.ac.za%,This is the hostname you decided to use for your repository. Base URL for the repository,dspace.baseUrl = %http://scholar.sun.ac.za%,Make sure to remove the "8080" port reference. Default user interface,dspace.ui = xmlui,We selected the XMLUI. The URL link used,dspace.url = ${dspace.baseUrl},Make sure to remove the "/${dspace.ui}". The long name for the repository,dspace.name = %SUNScholar Research Repository%,This is usually for the repository manager to decide. SOLR server connection,solr.server = http://localhost/solr,Make sure that you deploy the SOLR java web app correctly and make sure to remove the "8080" port reference. The default language,default.language = %en_ZA%,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,db.driver=org.postgresql.Driver,We selected the PostgreSQL driver. Database connection URL,db.url=jdbc:postgresql://localhost:5432/dspace,We connect locally on port 5432 to the "dspace" database. Database credentials,db.username=%dspace%
db.password=%dspace%,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.

# EXAMPLE "local.cfg" for DSpace.
#
# Any configurations added to this file will automatically OVERRIDE configurations
# of the same name in any of the DSpace *.cfg files. This includes overriding
# settings in any of these files:
#    * [dspace]/config/dspace.cfg
#    * Or any configuration file that is included in 'dspace.cfg'
#     (See "include = [filepath]" settings near the end of dspace.cfg.
#      By default, it includes all [dspace]/config/modules/*.cfg files)
#
# By default, this EXAMPLE file includes a number of commonly overridden configurations.
# * ADD configurations by simply copying them into this file from any existing *.cfg file.
# * REMOVE configurations by simply commenting them out or deleting them below.
#
# 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.
# Similarly, including "oai.solr.url" in this local.cfg will override the
# default value of "oai.solr.url" in the modules/oai.cfg file.
#


##########################
# SERVER CONFIGURATION   #
##########################

# 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=/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}/${dspace.ui}

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

# assetstore.dir, look at DSPACE/config/spring/api/bitstore.xml for more options
# default is ${dspace.dir}/assetstore, uncomment and modify if you need to use a different path
#assetstore.dir = ${dspace.dir}/assetstore
assetstore.dir = ${dspace.dir}/assetstore

# Default language for metadata values
#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 #
##########################
# DSpace only supports two database types: PostgreSQL or Oracle

# URL for connecting to database
#    * Postgres template: jdbc:postgresql://localhost:5432/dspace
#    * Oracle template: jdbc:oracle:thin:@//localhost:1521/xe
db.url = jdbc:postgresql://localhost:5432/dspace

# JDBC Driver
#    * For Postgres: org.postgresql.Driver
#    * For Oracle:   oracle.jdbc.OracleDriver
db.driver = org.postgresql.Driver

# Database Dialect (for Hibernate)
#    * For Postgres: org.dspace.storage.rdbms.hibernate.postgres.DSpacePostgreSQL82Dialect
#    * For Oracle:   org.hibernate.dialect.Oracle10gDialect
db.dialect = org.dspace.storage.rdbms.hibernate.postgres.DSpacePostgreSQL82Dialect

# Database username and password
db.username = %dspace%
db.password = %dspace%

# Database Schema name
#    * For Postgres, this is often "public" (default schema)
#    * For Oracle, schema is equivalent to the username of your database account,
#      so this may be set to ${db.username} in most scenarios.
db.schema = public

## Connection pool parameters

# Maximum number of DB connections in pool (default = 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

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


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

# 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.password= 

# SMTP mail server alternate port (defaults to 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%

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

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

# Recipient for server errors and alerts (defaults to mail.admin)
alert.recipient = %dspace-help@myu.edu%

# Recipient for new user registration emails (defaults to unspecified)
registration.notify = %dspace-help@myu.edu%


########################
# HANDLE CONFIGURATION #
########################
#
# Canonical Handle URL prefix
#
# Items in DSpace receive a unique URL, stored in dc.identifier.uri
# after it is generated during the submission process.
# 
# If you register with CNRI's handle service at http://www.handle.net/,
# these links can be generated as permalinks using http://hdl.handle.net/
# as canonical prefix. Please make sure to change handle.canonical.prefix
# after registering with handle.net by uncommenting one of the following
# lines, depending if you prefer to use http or https:
# handle.canonical.prefix = http://hdl.handle.net/
# handle.canonical.prefix = https://hdl.handle.net/
#
# 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.

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

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

Save and exit the file.

References

• https://wiki.duraspace.org/display/DSDOC6x/Installing+DSpace#InstallingDSpace-Installation
• https://github.com/DSpace/DSpace/blob/dspace-6.3/dspace/config/local.cfg.EXAMPLE