Date: Thu, 28 Mar 2024 16:27:44 -0400 (EDT) Message-ID: <1571107639.28882.1711657664955@lyrasis1-roc-mp1> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_28881_562304502.1711657664955" ------=_Part_28881_562304502.1711657664955 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
In the notes below [dspace]
refers to the install directory=
for your existing DSpace installation, and [dspace-source]
to=
the source directory for DSpace 1.8. Whenever you see these path reference=
s, be sure to replace them with the actual path names on your local system.=
You should also check the =EF=BB=BFDSpace Release 1.8.0 Notes to see what change=
s are in this version.
Changes to the DSpace 1.8 Upgrade / Co= nfiguration Process
In DSpace 1.8.0, there have been a few significant changes to how you up= grade and configure DSpace. Notably:
[dspace]/config/modules/
directory.=
=20
[dspace]/config/modules/authentication*.cfg=
files[dspace]/config/m=
odules/bulkedit.cfg
file[dspace]/config/modules/discovery.cfg
file[dspace]/config/modules/oai.cfg
file[dspace]/config/modules/solr-statistics.cfg=
file[dspace]/config/modules/sword*.cfg
filesdsp=
ace.cfg
configuration file.ant up=
date
upgrade command now defaults to replacing any =
existing configuration files (though the existing configuration files will =
first be backed up to a file with the suffix *.old
).=20
ant update
command would leave existing configuration files intact (and you would ha=
ve to manually merge in new configuration settings, which would be in a fil=
e with the suffix *.new
). If you prefer this previous behavior=
, you can still achieve the same result by running:=20
ant -Doverwrite=3Dfalse update
ant -Doverwrite=3D=
false update
please be aware that this will not auto-upgrade any of =
your configuration files. This means you must closely watch the output of t=
his command, and ensure you manually upgrade all configuration files in the=
[dspace]/config/
directory as well as all Solr configurations=
/schemas in the [dspace]/solr/search/conf/
and [dspace]/=
solr/statistics/conf/
directories.Before you start your upgrade, it is strongly recommended that you creat= e a backup of your DSpace instance. Backups are easy to recover from; a bot= ched install/upgrade is very difficult if not impossible to recover from. T= he DSpace specific things to backup are: configs, source code modifications= , database, and assetstore. On your server that runs DSpace, you might addi= tionally consider checking on your cron/scheduled tasks, servlet container,= and database.
Make a complete backup of your system, including:
pg_dump= -U [database-user] -f [backup-file-location] [database-name]
[dspace]/assetstore
 =
;by default, and any other assetstores configured in the [dspace]/con=
fig/dspace.cfg
"assetstore.dir" and "assetstore.dir.#" settings)[dspace]/co=
nfig
.[dspace-source]/dspace/modules/jspui/src/mai=
n/webapp/
[dspace-source]/dspace/modules/xmlui/src/mai=
n/webapp/
[dspace]/config
cd [dspace-source]/dspace/ mvn -U clean package
[dspace-source]/dspace/target/dspa=
ce-[version]-build.dir
. Inside this directory is the compiled binar=
y distribution of DSpace. Before rebuilding DSpace ('package'), the above c=
ommand will clean out any previously compiled code ('clean') and ensure tha=
t your local DSpace JAR files are updated from the remote maven repository.=
$CATALINA_HOME/shutdown.sh
script. (Many Uni=
x-based installations will have a startup/shutdown script in the /etc=
/init.d
or /etc/rc.d
directories.)cd [dsp= ace-source]/dspace/target/dspace-[version]-build.dir ant -Dconfig=3D[dspace]/config/dspace.cfg update
Changes to the behavior of the 'ant up= date' script
The ant update
script has changed slightly as of DSpace 1.8=
.0. It now defaults to replacing your existing configuration files (after b=
acking them up first). See the Changes to the DSpace 1.8 Upgrade / Configuration Process note at th=
e top of this page for more details.
Backup Your Database First
Applying a database change will alter your database! The database upgrad= e scripts have been tested, however, there is always a chance something cou= ld go wrong. So, do yourself a favor and create a backup of your database b= efore you run a script that will alter your database.
*.old
files in your newly updated [dspace]/con=
fig/
directory (and all sub-directories). During the update process,=
if there is a difference between your old 1.7-compatible configuration fil=
e and the new 1.8-compatible configuration file, your previous settings wil=
l be moved to a *.old
file. You may want to review the differe=
nces between the *.old
file and the new version of that file, =
and ensure your previous configurations/settings are merged into the new co=
nfiguration file. One way to compare these files is by using a comparison-u=
tility like diff
or a text editor that supports file compariso=
n.dspace.cfg
which now support richer features, such as iTune=
s podcast and publishing to iTunesUdspace.cfg
and separated into their own config files. Configuration sections which have been moved include Authentication s=
ettings, Batch Metadata Editing settings, Discovery settings, OAI-PMH/OAI-O=
RE settings, Statistics settings and SWORD settings. So, any configurations=
from these sections should be removed from your existing dspace.cfg file, =
as they will be ignored. For more information, see the Changes to the DSpace 1.8 Upgrade / Configuratio=
n Process note at the top of this page.[dspace=
]/config/modules/
directory. Each of these corresponds to a new feat=
ure in 1.8.0 (or a configuration section which has now been moved out of th=
e dspace.cfg file):=20
authentication-*.cfg
files : new location for Authentication Configurations.<=
/li>
bulkedit.cfg
: new location for Batch Metadata Editing Configuratio=
ns.discovery.cfg
: new location for Discovery Configurations.fetchccdata.cfg
: configuration for new "Fetch CC Data" Curation Task.oai.cfg
: new location for OAI-PMH / OAI-ORE Configurations.solr-statistics.cfg
: new location for Solr Statistics Configurations.spring.cfg
: configuration file for DSpace Service Manager=
(should not need modification).submission-curation.cfg
- configuration file for new Virus=
Scanning on Submission feature.sword-client.cfg
: configuration file for new SWORDv1 Client feature.sword-server.cfg
: new location for SWORDv1 Server Configurations.swordv2-server.cfg
: configuration file for new SWORDv2 Server feature.translator.cfg
: configuration for new "Microsoft Tra=
nslator" Curation Task.workflow.cfg
: configuration for new Configurable Workflow feature.[dspace]/config/spring/
directory =
which holds Spring Framework configuration files. The vast m=
ajority of users should never need to modify these settings, but they are a=
vailable for hardcore developers who wish to add new features via the DSpace Services Framework=
(based on Spring Framework).[dspace= ]/bin/dspace index-init
[dspace]/webapps
directory to the s=
ubdirectory of your servlet container (e.g. tomcat):=20
cp -R [= dspace]/webapps/* [tomcat]/webapps/
In DSpace 1.6.x & 1.7.x the file download statistics were generated = without regard to the bundle in which the file was located. In DSpace 1.8.0= it is possible to configure the bundles for which the file statistics are = to be shown by using the query.filter.bundles property. If= required the old file statistics can also be upgraded to include the bundl= e name so that the old file statistics are fixed.
Updating the file statistics will ensure that old file downloads statist= ics data will also be filterable using the filter bundle feature. The benef= it of upgrading is that only files within, for example, the "ORIGINAL" bund= le are shown as opposed to also showing statistics from the LICENSE bundle.= More information about this feature can be found at Statistics differences between DSpace 1.7.x and 1.8.0
Backup Your statistics data first
<= span class=3D"aui-icon aui-icon-small aui-iconfont-error confluence-informa= tion-macro-icon">Applying this change will involve dumping all the old file statistics in= to a file and re-loading them. Therefore it is wise to create a backup of t= he [DSpace]/solr/statistics/data directory. It is best to create this backu= p when the Tomcat/Jetty/Resin server program isn't running.
When a backup has been made, start the Tomcat/Jetty/Resin server program=
.
The update script has one option (-r
) which will, if given, n=
ot only update the broken file statistics but also delete statistics for fi=
les that were removed from the system. If this option isn't active, these s=
tatistics will receive the "BITSTREAM_DELETED" bundle name.
#The -r= is optional [dspace]/bin/dspace stats-util -b -r