...

What is the most current release of the DSpace software?

The most recent stable version of DSpace, recommended for production use, is available from SourceForge. For more information on the most recent release of the software see the Current Release Notes.

To see what's in store for the future, see Next Release Status and the DSpace RoadMap.

Where can I download the DSpace open source software?

DSpace is freely available as open source software from SourceForge.

If you are a developer, DSpace is also available to be checked out using Git/GitHub: https://github.com/DSpace/DSpace   See also Development with Git.

I have technical questions about DSpace – how can I find solutions?

You're in the right place. First, you'll want to search this FAQ to see if your question has been asked/answered already. Next, try searching the DSpace System Documentation and the DSpace-Tech mailing list archives.

...

Post your questions to the DSpace-tech mailing list, where members of the DSpace community will offer their assistance.
And once you find the answer, if you think others will be asking the same question post them here in the Technical FAQ page.

Is there install doc for DSpace?

Yes, the DSpace System Documentation includes a section on Installation. Read through this FAQ and also see Installation Guides.

If you run into any problems or have further questions, send an email to the DSpace-Tech mailing list for help.

How do I report bugs?

If you think you've found a bug, we recommend taking the following steps.

...

Thanks for being willing to help locate and report bugs! An active community helps us make more stable, bug-free software.

How do I request new features?

Before putting in a new feature request, you should make sure that the feature would be useful to the broader DSpace community and isn't institutional specific. It's also worth mentioning that since the DSpace developers are all volunteers, you may want to work to locate an interested developer who can help you scope out and begin to develop this new feature.

...

1. First, attempt to determine if this feature will be useful to everyone using DSpace. The best way to do this is to describe this feature in an email to the DSpace-Tech mailing list in order to begin the discussion.
2. Once you've determined your feature would be useful to all, please submit a feature request to DSpace Jira. Try to be as descriptive as possible. Describe the feature in as much detail as you can. Make sure to also describe why you feel this feature would be useful (i.e. what is the use case?)
3. Once your feature request is made, the DSpace developers will begin to review it and determine if a volunteer would step up to help developing it. Please be patient. Sometimes a volunteer can be found quickly. Other times it can take a while. If you can help us locate a volunteer developer, it is even more likely that the feature can be developed relatively quickly. If you don't hear anything for a while, follow-up with the DSpace developers by posting a comment to your initial feature request in Jira.

Internal System Error: I keep receiving the message "The system has experienced an internal error". How do I diagnose the problem?

See the Troubleshoot an error page for hints on which log files to check for errors, and the recommended way of sending these to the DSpace-Tech Mailing List

To view the DSpace log live

## In Linux, run the following command then reproduce the internal error state
## use the pathname prefix appropriate to your DSpace installation
tail -F /var/logs/dspace.log

## and you should see something of the kind

2009-05-18 12:52:45,935 WARN  org.dspace.app.webui.servlet.DSpaceServlet @ name\
@place:session_id=F32DD4066DD475B8841A2A2204961B9A:ip_addr=1.2\
.3.4:database_error:org.postgresql.util.PSQLException: ERROR: duplicate key \
violates unique constraint "metadatafieldregistry_pkey"
org.postgresql.util.PSQLException: ERROR: duplicate key violates unique constra\
int "metadatafieldregistry_pkey"
        at org.postgresql.core.v3.QueryExecutorImpl.receiveErrorResponse(QueryE\
xecutorImpl.java:1525)

What's the best strategy for backing up/restoring DSpace?

From the Documentation, see Storage Layer (which describes the basics for backing up your database and file storage). Also see AIP Backup and Restore, which describes how to backup your DSpace to a set of Archival Information Packages (AIPs).

Finally, there is a somewhat outdated summary at BackupRestore.

How do I run DSpace on port 80/443?

See Running DSpace on Standard Ports

Do I need HTTPS (SSL)?

See SecuringDspace,

Also ServletSecurity for more details.

How do I run DSpace on Windows?

See DSpaceOnWindows Installing DSpace on Windows

In the admin UI, the 'select E-person' tool isn't working.

A couple of things to try:

...

• The e-person tool is a pop-up window. Check that your browser isn't blocking pop-ups for your DSpace installation.
  This pop-up window was, in retrospect, a controversial point. Post explaining the decision
• If your site 'skin' has a form in it (e.g. a search box) this breaks the JavaScript, specifically the references in jsp/utils.js to window.document.forms0.
  • See http://sourceforge.net/tracker/index.php?func=detail&aid=1155173&group_id=19984&atid=119984 this bug report Another way to fix this problem may be to remove the form from the skin in dspace-admin/eperson-main.jsp. If, for example, you placed a search box in your location bar, changing locbar="/dmirror/http/wiki.dspace.org/link" to locbar="off" in the dspace:layout tag in eperson-main should resolve the issue.

How do you append data from a test server to a production environment?

Many people have two installs of DSpace: a test server and a production server. The problem is how to take data from the test server and integrate (move, append, migrate, etc.) it into the production server. The most common example is when you are ready to move a new collection from test into production. Note that this is a somewhat different problem than the need to move all data from a test server and completely overwrite any data on the production system, which may happen when first moving out of test and into production. RichardJones covers that scenario more completely here, along with a number of other DSpace-related topics.

...

• identifier.url
• description.provenance
• date.accessioned
• date.available
• date.issued
• format.extent
• format.mimetype
  All of these values should be deleted to avoid duplication, except for date.issued if the items have been published or publicly distributed before. However, Cody Green has written a bash shell script that will traverse a DSpace export (e.g., from your test server) and fix the metadata. Here is the link to that script: http://sunsite.utk.edu/diglib/dspace/dspace_migrate.sh (please note that the script will remove the date.issued field for all records).
  Also, the script is now included in the latest release.

Are there any tips on running DSpace on RedHat/Fedora Core Linux?

Many people have run into trouble getting DSpace running on Redhat/Fedora Core Linux, specifically, encountering CLASSPATH errors and relating to libgcj.
The easiest way to resolve this is to remove all the PM-based Java components, and install the original binary packages: Java SDK from Sun, and Ant and Tomcat from Apache.org.
To remove the PM Java stuff, do:

...

You also may wish to check Installation Guides for additional installation tips/suggestions relating to specific operating systems.

filter-media Hangs While Creating Search Index

If filter-media appears to hang after it creates the thumbnails and indexes text content, you may consider running filter-media as root. For some reason, certain users report that filter-media will hang after printing the following message:
Creating search index:

...

Also note that running index-all as dspace does not hang, even though it does (apparently) the same thing.

Setting logging level up to DEBUG

If something doesn't seem to be working, you can often find out more by upping the logging level of DSpace. To do this:

...

More information about DSpace log files is available in the DSpace System Documentation.

How do I add/index/display another Dublin Core field?

Adding a new Dublin Core field can be done from the Administrative User Interface of DSpace.

...

Additional help can be found in the on this wiki.

How do I add a field to the submission UI?

The DSpace System Documentation includes a chapter titled "Customizing and Configuring Submission User Interface" which details how to make this and many other Submission UI customizations.

How do I add a field to the Lucene search index?

The DSpace System Documentation includes a section on "Configuring Lucene Search Indexes" in the chapter on "Configuration and Customization".

How do I add a field to the simple item display page?

See the on this wiki for more help.

I've made a lot of modifications to DSpace, and I want to bring my code up to date with a later version of DSpace. What's the easiest way to do that?

See UpdatingLocalCodebase

When trying to add content to DSpace, all of the fields filled out appear null.

After setting up the DSpace database and properly setting up the application, most functionality appears normal. However, when adding content all the fields are null when it comes time to review a content submission. The Java errors thrown revolve around a null pointer exception.

• The root cause of the problem is that the database is set up using some character encoding other than UTF-8. The database must be set up using UTF-8 character encoding.

How do I run DSpace with Apache and Tomcat using the mod_jk connector?

See ModJk.

How do I run multiple instances of DSpace in one Tomcat Server?

See MultipleDspaceOneServer

How do localise the Creative Commons license?

See LocaliseCreativeCommons

DSPACE with ISO-8859-1 and others encodings

If you want to use an encoding other than UTF-8 you can edit the file src/org/dspace/storage/rdbms/DatabaseManager.java and modify the next lines

else if ((jdbctype == Types.CLOB && "oracle".equals(dbName)) || jdbctype == Types.VARCHAR)
  {
    // Support CLOBs in place of TEXT columns in Oracle
    row.setColumn(name, results.getString(i));
  }
  /*else if (jdbctype == Types.VARCHAR)
  {
    try
    {
       byte[] bytes = results.getBytes(i);
       if (bytes != null)
       {
           String mystring = new String(results.getBytes(i), "UTF-8");
           row.setColumn(name, mystring);
        }
        else
        {
            row.setColumn(name, results.getString(i));
        }
     }
     catch (UnsupportedEncodingException e)
     {
         // do nothing, UTF-8 is built in!
     }
   }*/

Clearing Cocoon (XMLUI) cache

Apache Cocoon, the DSpace component XMLUI is based on, keeps a cache of visited pages to speed up access to them. This can pose a problem usually during development of XMLUI themes, when you update XSL, but an older version of the page is served from cache instead of the current version being constructed. It's safe to clear the cache, the only impact it can have is on speed until the cache is repopulated.

...

/var/cache/tomcat5/work/Catalina/localhost/xmlui/cache-dir
/var/lib/tomcat6/work/Catalina/localhost/_/cache-dir
/opt/tomcat6/work/Catalina/localhost/xmlui/cache-dir
/usr/local/tomcat6/work/Catalina/localhost/xmlui/cache-dir

I changed access restrictions on a collection, but restrictions didn't change on its items

You have to remember that access restrictions are inherited from its parent collection only when items are submitted, not when access restrictions are modified. So the new items submitted to that collection will have the collection's restrictions you set, but existing items will keep their current permissions.

...

• In XMLUI, use Advanced Policy Manager. Log in as an administrator, in the Administrative menu, click Authorizations (under Access Control.) Then in the main pane, under the search box, there's a link to the tool (Advanced authorizations tool: Click here to go to the item wildcard policy admin tool).
• You can write a curation task (DSpace 1.7 and newer, see DSpace 1.8: Curation System, Curation Task Cookbook)
• You can write custom SQL query on the "resourcepolicy" table. On newer DSpace versions which use Discovery, update the discovery index (using the -f flag) after running the SQL query.

How do I remove the search box from the front page in XMLUI?

This will remove the search box from the homepage body and keep the search box in the menu:

<xsl:template name="disable_front-page-search" match="dri:div[@id='aspect.discovery.SiteViewer.div.front-page-search']">
</xsl:template>

I'm getting 'relation "bi_5_dis" does not exist' (or any other number)

These are the tables corresponding to individual browse indexes. Browse indexes are defined in dspace.cfg as webui.browse.index.1 through webui.browse.index.n and you can modify which metadata fields you want in the indexes, but you have to remember that after any such change, you need to re-create the indexes.

...

See also the relevant dspace.cfg section.

Duplicate items in Recent Submissions in XMLUI Discovery

This happens when you skip a step in the instructions for Discovery#EnablingDiscovery. In particular, forgetting to set  recent.submissions.count = 0 will mean that recent items continue to be rendered by the Browse aspect in addition to the Discovery aspect, resulting in duplication.

To fix this, set recent.submissions.count = 0 in [dspace]/config/dspace.cfg and restart your servlet container. If needed, also clear the Cocoon cache: TechnicalFaq#TechnicalFaq-ClearingCocoon(XMLUI)cache

How do I update Messages.properties without rebuilding DSpace?

The Messages.properties file is used for translations both in DSpace core ([dspace]/lib/dspace-api-4.0-SNAPSHOT.jar) and in DSpace JSPUI ([dspace]/webapps/jspui/WEB-INF/lib/dspace-api-4.0-SNAPSHOT.jar). You usually want to update the JSPUI one:

1. find dspace-api-X.X.jar in [dspace]/webapps/jspui/WEB-INF/lib/
2. unzip it in an external folder
3. modify the Message.properties file
4. copy Message.properties to [dspace]/webapps/jspui/WEB-INF/classes/
5. restart your servlet container 

I'm getting "SolrException: Bad Request" followed by a long query or a "tooManyClauses" Exception

From the related email thread:

...

•  increment maxBooleanClauses; or
• disable Access Rights Awareness
  

Errors connecting to Solr

...