AgriOcean DSpace, a customized version of DSpace. Technical background

AgriOcean DSpace, a customized version of DSpace.

Technical background

DSpace is an application which uses a web server (Tomcat) and a database server (Postgresql). The end user accesses the

DSpace application on the Tomcat web server, which connects to a database on the Postgresql server.

Tomcat is installed under Program Files and has specific management software (Monitor, Configure)

Postgresql is installed under Program Files. It is strongly advised to install the data directories outside Windows system

directories. PgAdmin III is a client software to manage the databases on the Postgresql server

The DSpace application has its application under the webapps directory of Tomcat. The configuration and management

DSpace configuration and management: overview

The Dspace management directories are in the ..\repos directory. The main subdirectories are

 assetstore: contains the uploaded files (pdf, word, etc)

 bin: command line scripts for different tasks: creation of an

administrator, updating indexes, etc,

 config: with dspace.cfg (main configuration file) and

(input-forms-extended.xml (submission format file)

 log: use and error logs

Adapting the basic configuration of AgriOcean DSpace by

changing dspace.cfg

(by default in <repos_directory>\config)

The configuration of DSpace is defined in text files. The main configuration file is dspace.cfg.

If you look at dspace.cfg, you see too many options. In the next table you will find the most important options. We already fine-tuned as much as possible the installation. Still, you want to personalize it further. Therefore read carefully the information in this document.

For further changes, read carefully the comments for every parameter in the

configuration file. Make always a copy of your original file before making changes. If you want to change other parameters than the one described below, contact me.

Configuration option in dspace.cfg:

!! Touch only the configuration marked in red !!

Comment

##### Basic information ######

# DSpace installation directory

dspace.dir = c:/aod/repos

#: used to uncomment a whole line of configuration. It will not be used.

If you want to install AgriOcean DSpace in another directory, all the reference to the base directory has to be changed to in the next files: <repos_directory> 1. \config\dspace.cfg 2. \config\log4j.properties 3. \config\log4j-handle-plugin.properties <tomcat_directory>\webapps 4. \agriocean\WEB-INF\web.xml 5. \oai\WEB-INF\web.xml 6. \solr\WEB-INF\web.xml

# DSpace host name - should match base URL. Do not include port number

dspace.hostname = localhost

# DSpace base host URL. Include port number etc.

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.baseUrl}/dspace

# The base URL of the OAI webapp (do not include /request).

dspace.oai.url = ${dspace.baseUrl}/oai # Name of the site

dspace.name = AgriOcean

Agriocean DSpace is installed on your local machine, to make it visible for external users you need to give it the name of your server: A URL or an IP - E.g. www.yourinstitute.org or 168.1.1.5 (ask your network manager). If tomcat is installed on port 80 you have to change the port number.

When changing the port number, change it also in file <repos_directory>\config\dspace-solr-search.cfg

The url of your institute will be www.yourinstitute.org/dspace

If you want to rename the extension, you also have to rename it in the

tomcat-webapps directory

Here you can adapt the name, which will be used on the website

##### Database settings #####

# Database name ("oracle", or "postgres")

db.name = ${default.db.name} db.name = postgres

#db.name = oracle

# URL for connecting to database

#db.url = ${default.db.url}

db.url = jdbc:postgresql://localhost:5432/aod

# JDBC Driver

#db.driver = ${default.db.driver} db.driver = org.postgresql.Driver

# Database username and password

#db.username = ${default.db.username} #db.password = ${default.db.password} db.username = dspace

db.password = your password

If you want to change database elements (eg name, password) you have to adapt them first through pgAdmin III.

##### Email settings ######

# SMTP mail server

mail.server=smtp.gmail.com

# SMTP mail server authentication username and password (if required)

mail.server.username = [email protected] mail.server.password = yourpassword

# SMTP mail server alternate port (defaults to 25)

mail.server.port = 25

# From address for mail

mail.from.address = [email protected]

# Currently limited to one recipient!

feedback.recipient = [email protected]

# General site administration (Webmaster) e-mail

mail.admin = [email protected]

# Recipient for server errors and alerts

alert.recipient = [email protected]

# Recipient for new user registration emails

registration.notify = [email protected]

# An option is added to disable the mailserver. By default, this property is set to false

# By setting mail.server.disabled = true, DSpace will not send out emails. # It will instead log the subject of the email which should have been sent # This is especially useful for development and test environments where production data is used when testing functionality.

mail.server.disabled = false

It is possible to use a gmail as a mail server. We created a general account. So you can use already all the services of AgriOcean

DSpace (even when your server is defined on localhost).

But every user should create their own gmail account and fill out the mail and password where required.

If you use a local email server, consult the dspace manual for installation.

When changing the email address, change it also in the file

##Statistical Report Configuration Settings ##

# should the stats be publicly available? should be set to false if you only # want administrators to access the stats, or you do not intend to generate # any

report.public = false

# directory where live reports are stored

report.dir = ${dspace.dir}/reports/

You can make your statistics available by changing report.public to ‘true’

#---JSPUI SPECIFIC CONFIGURATIONS---#

### i18n - Locales / Language #### # Default Locale

# A Locale in the form country or country_language or country_language_variant # if no default locale is defined the server default locale will be used.

default.locale = en

# All the Locales, that are supported by this instance of DSpace

webui.supported.locales = en, fr, es

The standard language for the interface is English.

In the menus French and Spanish are also supported if the translation is available.

The Message properties can be adapted in: <tomcat_directory>\webapps\dspace\WEB-INF\classes

#---SOLR STATISTICS CONFIGURATIONS----#

##### Usage Logging #####

solr.log.server =

http://localhost:8080/solr/statistics

If you have defined tomcat under another port, you have to change this here.

Also change the port number in

<repos_directory>\config\ dspace-solr-search.cfg

#AgriOcean project specific CONFIGURATIONS# batchimport.customxml.enable = false

If you use a batch import translation file which is not defined in the batch import module on the collection page

Use and error logs

At <repos_directory>\log:

Every activity on the server is registered in daily log files. This is a way to analyze errors. It is most of the time to technical for users. But it will help us to solve users problems. Users have to send me the dspace.log.<date> file and a description of the problem.

Bin scripts

At <repos_directory>\bin To be used from the

command line: Main commands:

- create-administrator - index-init

- itemcounter

- all the stat-commands and generate-sitemaps when on line

Commands have the followings syntax:

Changing the AOD interface (as Tomcat Web application)

The interface is defined under <tomcat_directory>\webapps.

People will like to modify the header. This can be done by changing the file banner-large.jpg. Keep the same pixels size.

To change the menu messages, adapt the Messages.properties.

We need support for the translations from English to other languages. Now if the translation is not available, it will use the default Messages.properties definitions.

Managing Postgresql with the PgAdmin III client

Postgresql is a server application which after installation runs automatically on Windows.

The metadata of AOD is contained in database

(aod).

With pgAdmin III it is possible to access the data-base through an interface.

Only use for global tasks like backup, restore and upgrade tasks.

Managing Tomcat

The first time after installation Tomcat starts automatically. Later, you can start it with Monitor Tomcat from the Windows Program Menu or from the Task Bar.

If Windows requests Administrator rights, run it as Administrator

Localhost is sometimes blocked by Internet Explorer. Therefore it is easier to use Firefox, Chrome, Safari as browser.

To set up Tomcat to start up automatically, go to Configure Tomcat (in Windows Program Menu).

Set Status type on Automatic:

Backup procedures

After installation and customization: Make a copy of:





Regular backups of the data (daily – weekly):

Make a copy of





Creation of a back-up of aod database with pgAdmin III

1. Start pgAdmin III and open the database aod

2. Click with the right button on AOD and a menu will open 3. Choose backup

4. Enter the directory and filename to save the backup 5. After clicking on the Backup button the process will be