Page History
...
- Download the latest DSpace release from the DSpace GitHub Repository. You can choose to either download the zip or tar.gz file provided by GitHub, or you can use "git" to checkout the appropriate tag (e.g.
dspace-7.2
) or branch.- Unpack it using "unzip" or "gunzip". If you have an older version of DSpace installed on this same server, you may wish to unpack it to a different location than that release. This will ensure no files are accidentally overwritten during the unpacking process, and allow you to compare configs side by side.
- For ease of reference, we will refer to the location of this unzipped version of the DSpace release as [dspace-source] in the remainder of these instructions.
- If upgrading from 6.x or below, a few extra steps are required before you install DSpace 7.x. If you are upgrading from a previous version of 7.x, skip this and move along.
- Ensure that your database is compatible: Starting with DSpace 6.x, there are new database requirements for DSpace (refer to the Backend Requirements section of "Installing DSpace" for full details).
- PostgreSQL databases: PostgreSQL 9.4 or above is required and the "pgcrypto" extension must be installed.
- Notes on installing pgcrypto
- On most Linux operating systems (Ubuntu, Debian, RedHat), this extension is provided in the "postgresql-contrib" package in your package manager. So, ensure you've installed "postgresql-contrib".
- On Windows, this extension should be provided automatically by the installer (check your "[PostgreSQL]/share/extension" folder for files starting with "pgcrypto")
Enabling pgcrypto on your DSpace database. (Additional options/notes in the Installation Documentation)
Code Block # Login to your "dspace" database as a superuser psql --username=postgres dspace # Enable the pgcrypto extension on this database CREATE EXTENSION pgcrypto;
- Notes on installing pgcrypto
- Oracle databases: Oracle support has been deprecated in DSpace. It will no longer be supported as of June/July 2023. See https://github.com/DSpace/DSpace/issues/8214 for more details.
- PostgreSQL databases: PostgreSQL 9.4 or above is required and the "pgcrypto" extension must be installed.
From your old version of DSpace, dump yourAnchor dump_solr dump_solr authority
andstatistics
Solr cores. (Only necessary if you want to keep both your authority records and/or SOLR Statistics)Code Block language bash [dspace]/bin/dspace solr-export-statistics -i authority [dspace]/bin/dspace solr-export-statistics -i statistics
The dumps will be written to the directory
[dspace]/solr-export
. This may take a long time and require quite a lot of storage. In particular, the statistics core is likely to be huge, perhaps double the size of the content ofsolr/statistics/data
. You should ensure that you have sufficient free storage.
This is not the same as the disaster-recovery backup that was done above. These dumps will be reloaded into new, reconfigured cores later.
If you were sharding your statistics data, you will need to dump each shard separately. The index names for prior years will bestatistics-YYYY
(for example:statistics-2017 statistics-2018
etc.) The current year's statistics shard is namedstatistics
and you should dump that one too.Warning Unfortunately, the "solr-export-statistics" script was not created until DSpace 5.x. Therefore, you will not be able to upgrade statistics from 4.x or below unless you first upgrade to either 5.x or 6.x. This upgrade could be done in a test environment, to allow you to export your statistics (so they can be reimported into 7.x below). But, there's unfortunately no direct way to migrate 4.x (or 3.x or 1.x.x) Solr Statistics into 7.x.
- Move your old Solr cores to a safe location in case of trouble with the upgrade procedure. If you leave them in place, you will get a mixture of old and new files that the new Solr will refuse to load.
(If upgrading from 5.x or below) Replace your old build.properties file with a local.cfg: As of DSpace 6.0, the
build.properties
configuration file has been replaced by an enhancedlocal.cfg
configuration file. Therefore, any oldbuild.properties
file (or similar[dspace-source]/*.properties
files) WILL BE IGNORED. Instead, you should create a newlocal.cfg
file, based on the provided[dspace-source]/dspace/config/local.cfg.EXAMPLE
and use it to specify all of your locally customized DSpace configurations. This newlocal.cfg
can be used to override ANY setting in any other configuration file (dspace.cfg
ormodules/*.cfg
). To override a default setting, simply copy the configuration into yourlocal.cfg
and change its value(s). For much more information on the features of local.cfg, see the Configuration Reference documentation and the local.cfg Configuration File section on that page.Code Block cd [dspace-source] cp dspace/config/local.cfg.EXAMPLE local.cfg # Then edit the local.cfg, specifying (at a minimum) your basic DSpace configuration settings. # Optionally, you may copy any settings from other *.cfg configuration files into your local.cfg to override them. # After building DSpace, this local.cfg will be copied to [dspace]/config/local.cfg, where it will also be used at runtime.
- Ensure that your database is compatible: Starting with DSpace 6.x, there are new database requirements for DSpace (refer to the Backend Requirements section of "Installing DSpace" for full details).
Build DSpace Backend. Run the following commands to compile DSpace :
Code Block cd [dspace-source] mvn -U clean package
The above command will re-compile the DSpace source code and build its "installer". You will find the result in
[dspace-source]/dspace/target/dspace-installer
Info title Defaults to PostgreSQL settings Without any extra arguments, the DSpace installation package is initialized for PostgreSQL. If you use Oracle instead, you should build the DSpace installation package as follows:
mvn -Ddb.name=oracle -U clean package
Stop Tomcat (or servlet container). Take down your servlet container.
- For Tomcat, use the
$CATALINA_HOME/shutdown.sh
script. (Many Unix-based installations will have a startup/shutdown script in the/etc/init.d
or/etc/rc.d
directories.)
- For Tomcat, use the
- Update your DSpace Configurations. Depending on the version of DSpace you are upgrading from, not all steps are required.
- If you are upgrading from a prior version of DSpace 7.x, you will need to perform the following steps.
As of DSpace 7.3, the "db.dialect" configuration has changed from "org.dspace.storage.rdbms.hibernate.postgres.DSpacePostgreSQL82Dialect" to "org.hibernate.dialect.PostgreSQL94Dialect". Therefore, MAKE SURE that your dspace.cfg or local.cfg has this setting:
Code Block db.dialect = org.hibernate.dialect.PostgreSQL94Dialect
- You may wish to review the Release Notes for details about new features. There may be new configurations you may wish to tweak to enable/disable those features.
- Make sure your existing 7.x local.cfg is in the source directory (e.g.
[dspace-source]/dspace/config/local.cfg
). That way your existing 7.x configuration gets reinstalled alongside the new version of DSpace.
- If you are upgrading from DSpace 6.x or below, you will need to perform these steps.
- Review your customized configurations (recommended to be in local.cfg): As mentioned above, we recommend any local configuration changes be placed in a local.cfg Configuration File. With any major upgrade some configurations may have changed. Therefore, it is recommended to review all configuration changes that exist in the
config
directory, and its subdirectories, concentrating on configurations your previously customized in your local.cfg. See also the Configuration Reference. - Remove obsolete configurations. With the removal of the JSPUI and XMLUI, a large number of server-side (backend) configurations were made obsolete and were therefore removed between the 6.x and 7.0 release. A full list can be found in the Release Notes.
- Remove BTE Spring configuration: If it exists, remove the
[dspace]/config/spring/api/bte.xml
Spring Configuration. This file is no longer needed as the BTE framework was removed in favor of Live Import from external sources. - Migrate or recreate your Submission configuration. As of DSpace 7, the submission configuration has changed. The format of the "item-submission.xml" file has been updated, and the older "input-forms.xml" has been replaced by a new "submission-forms.xml". You can choose to either start fresh with the new v7 configuration files, or you can use the steps below to migrate your old configurations into the new format. See the Submission User Interface for more information
First, create a temporary folder to copy your old v6 configurations into
Code Block # Example of creating a [dspace]/config/temp folder for this migration # You must replace [dspace] with the full path of your DSpace 7 installation. cd [dspace]/config mkdir temp
- Copy your old (v5 or v6) "item-submission.xml" and "input-forms.xml" into that temporary folder
Run the command-line migration script to migrate them to v7 configuration files
Code Block # This example uses [dspace] as a placeholder for all paths. # Replace it with either the absolute or relative path of these files [dspace]/bin/dspace submission-forms-migrate -s [dspace]/config/temp/item-submission.xml -f [dspace]/config/temp/input-forms.xml
- The result will be two files. These are valid v7 configurations based on your original submission configuration files.
[dspace]/config/item-submission.xml.migrated
[dspace]/config/submission-forms.xml.migrated
- These "*.migrated" files have no inline comments, so you may want to edit them further before installing them (by removing the ".migrated" suffix). Alternatively, you may choose to copy sections of the *.migrated files into the default configurations in the
[dspace]/config/
folder, therefore retaining the inline comments in those default files.
- City IP Database file for Solr Statistics has been renamed. The old
[dspace]/config/GeoLiteCity.dat
file is no longer maintained by its provider. You can delete it. The new file is namedGeoLite2-City.mmdb
by default. If you have configured a different name and/or location for this file, you should check the setting ofusage-statistics.dbfile
in[dspace]/config/modules/usage-statistics.cfg
(and perhaps move your custom setting tolocal.cfg
). - tm-extractors media filtering (WordFilter) no longer exists: the PoiWordFilter plugin now fulfills this function. If you still have WordFilter configured, remove from
dspace.cfg
and/orlocal.cfg
all lines referencingorg.dspace.app.mediafilter.WordFilter
and uncomment all lines referencingorg.dspace.app.mediafilter.PoiWordFilter
. - Re-configure Solr URLs: change the value of
solr.server
to point at your new Solr external service. It will probably become something likesolr.server = https://localhost:8983/solr
. Solr only needs to be accessible to the DSpace backend, and should not be publicly available on the web. It can either be run on localhost or via a hostname (if run on a separate server from the backend). Also review the values ofdiscovery.search.server
oai.solr.url
solr.authority.server
solr-statistics.server
- Sitemaps are now automatically generated/updated: A new
sitemap.cron
setting exists in the dspace.cfg which controls when Sitemaps are generated. By default they are enabled to update once per day, for optimal SEO. See Search Engine Optimization docs for more detail- Because of this change, if you had a system cron job which ran "
./dspace generate-sitemaps
", this system cron job can be removed in favor of the newsitemap.cron
setting.
- Because of this change, if you had a system cron job which ran "
- Review your customized configurations (recommended to be in local.cfg): As mentioned above, we recommend any local configuration changes be placed in a local.cfg Configuration File. With any major upgrade some configurations may have changed. Therefore, it is recommended to review all configuration changes that exist in the
- If you are upgrading from DSpace 5.x or below, there are a few additional configuration changes to be aware of.
- Search/Browse requires Discovery: As of DSpace 6, only Discovery (Apache Solr) is supported for search/browse. Support for Legacy Search (using Apache Lucene) and Legacy Browse (using database tables) has been removed, along with all their configurations.
- XPDF media filtering no longer exists: XPDF media filtering, deprecated in DSpace 5, has been removed. If you used this, you will need to reconfigure using the remaining alternatives (e.g. PDF Text Extractor and/or ImageMagick PDF Thumbnail Generator).
- If you are upgrading from a prior version of DSpace 7.x, you will need to perform the following steps.
Update DSpace Installation. Update the DSpace installation directory with the new code and libraries. Issue the following commands:
Code Block cd [dspace-source]/dspace/target/dspace-installer ant update
- Upgrade your database (required for all upgrades). The DSpace code will automatically upgrade your database (from any prior version of DSpace). By default, this database upgrade occurs automatically when you restart Tomcat (or your servlet container). However, if you have a large repository or are upgrading across multiple versions of DSpace at once, you may wish to manually perform the upgrade (as it could take some time, anywhere from 5-15 minutes for large sites).
(Optional) If desired, you can optionally verify which migrations have not yet been run on your database. You can use this to double check that DSpace is recognizing your database version appropriately
Code Block [dspace]/bin/dspace database info # If you are upgrading from 5.x or later, then this will list all migrations # which were previously run, along with any which are "PENDING" or "IGNORED" # that need to be run to upgrade your database. # If you are upgrading from 4.x or earlier, this will attempt to detect which # version of DSpace you are upgrading from. Look for a line at the bottom # that says something like: # "Your database looks to be compatible with DSpace version ___"
(Optional) In some rare scenarios, if your database's "sequences" are outdated, inconsistent or incorrect, a database migration error may occur (in your DSpace logs). While this is seemingly a rare occurrence, you may choose to run the "update-sequences" command PRIOR to upgrading your database. If your database sequences are inconsistent or incorrect, this "update-sequences" command will auto-correct them (otherwise, it will do nothing).
Code Block # This command only works if upgrading from DSpace 7.0 or later [dspace]/bin/dspace database update-sequences # If upgrading from DSpace 6 or below, this script had to be run via psql from [dspace]/etc/postgres/update-sequences.sql # For example: # psql -U [database-user] -f [dspace]/etc/postgres/update-sequences.sql [database-name] # NOTE: It is important to run the "update-sequences" script which came with the OLDER version of DSpace (the version you are upgrading from)! If you've misplaced # this older version of the script, you can download it from our codebase & run it via the "psql" command above. # DSpace 6.x version of "update-sequences.sql": https://github.com/DSpace/DSpace/blob/dspace-6_x/dspace/etc/postgres/update-sequences.sql # DSpace 5.x version of "update-sequences.sql": https://github.com/DSpace/DSpace/blob/dspace-5_x/dspace/etc/postgres/update-sequences.sql
(REQUIRED) Then, you can upgrade your DSpace database to the latest version of DSpace. (NOTE: check the DSpace log,
[dspace]/log/dspace.log.[date]
, for any output from this command)Code Block # If upgrading from DSpace 6.x or below [dspace]/bin/dspace database migrate ignored # If upgrading from an earlier version of DSpace 7.x [dspace]/bin/dspace database migrate
If you are upgrading from DSpace 6.x or below be sure you include the "ignored" parameter! There are database changes which were previously optional but now are mandatory (specifically Configurable Workflow database changes).
- If the database upgrade process fails or throws errors, then look at the "Troubleshooting Upgrade Issues" section below for possible tips/hints.
- More information on the "database" command can be found in Database Utilities documentation.
Note title By default, your site will be automatically reindexed after a database upgrade If any database migrations are run (even during minor release upgrades), then by default DSpace will automatically reindex all content in your site. This process is run automatically in order to ensure that any database-level changes are also immediately updated within the search/browse interfaces. See the notes below under "Restart Tomcat (servlet container)" for more information.
However, you may choose to skip automatic reindexing. Some sites choose to run the reindex process manually in order to better control when/how it runs.
To disable automatic reindexing, setdiscovery.autoReindex = false
inconfig/local.cfg
orconfig/modules/discovery.cfg
.As you have disabled automatic reindexing, make sure to manually reindex your site by running
[dspace]/bin/dspace index-discovery -b
(This must be run after restarting Tomcat)WARNING: It is not recommended to skip automatic reindexing, unless you will manually reindex at a later time, or have verified that a reindex is not necessary. Forgetting to reindex your site after an upgrade may result in unexpected errors or instabilties.
Deploy Server web application: The DSpace backend consists of a single "server" webapp (in
[dspace]/webapps/server
). You need to deploy this webapp into your Servlet Container (e.g. Tomcat). Generally, there are two options (or techniques) which you could use...either configure Tomcat to find the DSpace "server" webapp, or copy the "server" webapp into Tomcat's own webapps folder. For more information & example commands, see the Installation Guide- Optionally, you may also install the deprecated DSpace 6.x REST API web application ("rest" webapp). If you previously used the DSpace 6.x REST API, for backwards compatibility the old, deprecated "rest" webapp is still available to install (in
[dspace]/webapps/rest
). It is NOT used by the DSpace UI/frontend. So, most users should skip this step.
- Optionally, you may also install the deprecated DSpace 6.x REST API web application ("rest" webapp). If you previously used the DSpace 6.x REST API, for backwards compatibility the old, deprecated "rest" webapp is still available to install (in
- If upgrading from a previous version of 7.x, a few extra steps may be required before starting Tomcat.
- Update your Solr schema definition(s)
If you are upgrading from one 7.x release to another, you will need to update your 'search' Solr schema definition with the new version (For example, in 7.1 a new "search.entitytype" field was added to this schema. In 7.6, a new "lastModified_dt" field was added to this schema.).
Copy the updated schema.xml to your Solr 'search' core, e.g.
Code Block # The destination directory may differ per OS. # Just replace the existing 'search' core "schema.xml" with the new one. cp [dspace]/solr/search/conf/schema.xml /var/solr/data/search/conf/
Restart Solr
Code Block [solr]/bin/solr restart
Reindex your site
Code Block [dspace]/bin/dspace index-discovery -b
- Update your Solr schema definition(s)
- If upgrading from 6.x or below, a few extra steps are required to before starting Tomcat.If you are upgrading from a previous version of 7.x, skip this and move along.
Install new Solr cores and rebuild your indexes. (Required when upgrading from 6.x or below. This may be done after starting Tomcat, but is required for DSpace 7.x to function properly.)Anchor new_solr_cores new_solr_cores Copy the new, empty Solr cores to your new Solr instance.
Code Block cp -R [dspace]/solr/* [solr]/server/solr/configsets chown -R solr:solr [solr]/server/solr/configsets
Start Solr, or restart it if it is running, so that these new cores are loaded.
Code Block [solr]/bin/solr restart
You can check the status of Solr and your new DSpace cores by using its administrative web interface. Browse to
${solr.server}
(e.g.http://localhost:8983/solr/)
to see if Solr is running well, then look at the cores by selecting (on the left) Core Admin or using the Core Selector drop list.- For example, to test that your "search" core is setup properly, try accessing the URL
${solr.server}/search/select
. It should run an empty query against the "search" core, returning an empty JSON result. If it returns an error, then that means your "search" core is missing or not installed properly.
- For example, to test that your "search" core is setup properly, try accessing the URL
LoadAnchor reload_solr reload_solr authority
andstatistics
from the CSV dumps that you made earlier in Step 2 above.Code Block language bash [dspace]/bin/dspace solr-import-statistics -i authority [dspace]/bin/dspace solr-import-statistics -i statistics
This could take quite some time.
If you had sharded your statistics, you will need to load the dump of each shard separately into the "statistics" core. DSpace 7 does not support Solr shards at this time. Unfortunately, this will involve renaming all CSV export files to remove the year (e.g. rename "statistics-2012_export_2013-12_5.csv" to "statistics_export_2013-12_5.csv") and rerunning "[dspace]/bin/dspace solr-import-statistics -i statistics". More advice on this process can be found in this dspace-tech mailing list thread.For Statistics shards only, upgrade legacy DSpace Object Identifiers (pre-6.4 statistics) to UUID Identifiers.
Code Block [dspace]/bin/dspace solr-upgrade-statistics-6x -i statistics
Again If you had sharded your statistics, you will need to run this for each shard separately. See also SOLR Statistics Maintenance#UpgradeLegacyDSpaceObjectIdentifiers(pre-6xstatistics)toDSpace6xUUIDIdentifiers
Rebuild the
oai
andsearch
cores.Code Block language bash [dspace]/bin/dspace oai import [dspace]/bin/dspace index-discovery -b
If you have a great deal of content, this could take a long time.
Update Handle Server Configuration. (Required when upgrading from 6.x or below) Because we've updated to Handle Server v9, if you are using the built-in Handle server (most installations do), you'll need to add the follow to the end of the server_config section of your
[dspace]/handle-server/config.dct
file (the only new line is the "enable_txn_queue" line)Code Block "case_sensitive" = "no" "storage_type" = "CUSTOM" "storage_class" = "org.dspace.handle.HandlePlugin" "enable_txn_queue" = "no"
- Alternatively, you could re-run the
./dspace make-handle-config
script, which is in charge of updating thisconfig.dct
file.
- Alternatively, you could re-run the
(Optional) Set up IP to City database for location-based statistics. If you wish to (continue to) record the geographic origin of client activity, you will need to install (and regularly update) one of the following:Anchor ip_to_city_database ip_to_city_database - Either, a copy of MaxMind's GeoLite City database (in MMDB format)
- NOTE: Installing MaxMind GeoLite2 is free. However, you must sign up for a (free) MaxMind account in order to obtain a license key to use the GeoLite2 database.
- You may download GeoLite2 directly from MaxMind, or many Linux distributions provide the
geoipupdate
tool directly via their package manager. You will still need to configure your license key prior to usage. - Once the "GeoLite2-City.mmdb" database file is installed on your system, you will need to configure its location as the value of
usage-statistics.dbfile
in yourlocal.cfg
configuration file . - You can discard any old GeoLiteCity.dat database(s) found in the
config/
directory (if they exist). - See the "Managing the City Database File" section of SOLR Statistics for more information about using a City Database with DSpace.
- Or, you can alternatively use/install DB-IP's City Lite database (in MMDB format)
- This database is also free to use, but does not require an account to download.
- Once the "dbip-city-lite.mmdb" database file is installed on your system, you will need to configure its location as the value of
usage-statistics.dbfile
in yourlocal.cfg
configuration file . - See the "Managing the City Database File" section of SOLR Statistics for more information about using a City Database with DSpace.
- Either, a copy of MaxMind's GeoLite City database (in MMDB format)
Check your cron / Task Scheduler jobs. In recent versions of DSpace, some of the scripts names have changed.
Check the Scheduled Tasks via Cron documentation for details. If you have been using the
dspace stats-util --optimize
tool, it is no longer recommended and you should stop.- WINDOWS NOTE: If you are running the Handle Server on a Windows machine, a new
[dspace]/bin/start-handle-server.bat
script is available to more easily startup your Handle Server.
Restart Tomcat (servlet container). Now restart your servlet container (Tomcat/Jetty/Resin) and test out the upgrade.
- Upgrade of database: If you didn't manually upgrade your database in the previous step, then your database will be automatically upgraded to the latest version. This may take some time (seconds to minutes), depending on the size of your repository, etc. Check the DSpace log (
[dspace]/log/dspace.log.[date]
) for information on its status.
- Upgrade of database: If you didn't manually upgrade your database in the previous step, then your database will be automatically upgraded to the latest version. This may take some time (seconds to minutes), depending on the size of your repository, etc. Check the DSpace log (
Reindexing of all content for search/browse: If your database was just upgraded (either manually or automatically), all the content in your DSpace will be automatically re-indexed for searching/browsing. As the process can take some time (minutes to hours, depending on the size of your repository), it is performed in the background; meanwhile, DSpace can be used as the index is gradually filled. But, keep in mind that not all content will be visible until the indexing process is completed. Again, check the DSpace log (
.[dspace]/log/dspace.log.[date]
) for information on its status. If you wish to skip automatic reindexing, please see the Note above under the "Upgrade your Database" stepWhen upgrading from 7.0/7.1/7.2 to 7.3, it is REQUIRED to reindex your content. If reindexing does not occur automatically, or you disabled it, then run "./dspace index-discovery -b" to reindex your site.
# Manually reindex all contentCode Block .
/dspace index-discovery -b- Review / Update your scheduled tasks (e.g. cron jobs). For all features of DSpace to work properly, there are some scheduled tasks you MUST setup to run on a regular basis. Some examples are tasks that help create thumbnails (for images), do full-text indexing (of textual content) and send out subscription emails. See the Scheduled Tasks via Cron for more details.
- When upgrading to 7.5 (or later) , you will want to make sure the new "subscription-send" task is added to your existing scheduled tasks (in cron or similar). This new task is in charge of sending Email Subscriptions for any users who have subscribed to updates. (NOTE: "subscription-send" replaces the older "sub-daily" task from 6.x or below). See the Scheduled Tasks via Cron for more details.
- Install or Upgrade the new User Interface (see below)
...
- If upgrading from 6.x or below, install the new User Interface per the Installing DSpace guide. The JSPUI and XMLUI are no longer supported and cannot work with the DSpace 7 backend. You will need to install the new (Angular.io) User Interface.
- JSPUI or XMLUI based themes cannot be migrated. That said, since the new Angular UI also uses Bootstrap, you may be able to borrow some basic CSS from your old themes. But any HTML-level changes will need to be reimplemented in the new UI.
- If upgrading from a prior version of 7.x, upgrading requires installing the latest version of the User Interface code
- Upgrade Node.js if necessary
- If upgrading to 7.5, we highly recommend using either Node.js 16 or 18 as Node.js 14 will enter EOL (end of life) as of 30 April 2023.
- Download the latest dspace-angular release from the DSpace GitHub repository. You can choose to either download the zip or tar.gz file provided by GitHub, or you can use "git" to checkout the appropriate tag (e.g.
dspace-7.2
) or branch.- If you've cloned or copied this code into your own GitHub or GitLab repository, you may wish to simply pull the latest tagged code into your codebase using Git. That will allow you to more easily address any "code conflicts" between your local changes and the new version of DSpace (if any are found).
- NOTE: For the rest of these instructions, we'll refer to the source code location as
[dspace-angular].
Install any updated local dependencies using Yarn in the
[dspace-angular]
source code directory:Code Block # change directory to our repo cd [dspace-angular] # install/update the local dependencies yarn install
Build the latest User Interface code for Production: This rebuilds the latest code into the
[dspace-angular]/dist
directoryCode Block yarn build:prod
- If upgrading from 7.0 or 7.1, read the updated version 7 Installation documentation
- . As of 7.2, we now recommend deploying the compiled User Interface (in
[dspace-angular]/dist
) to a different directory (which we refer to as[dspace-ui-deploy]
) in order to keep your running UI separate from the source code. While it's still possible to run the UI using "yarn start" or "yarn run serve:ssr" (both of which use[dspace-angular]/dist
),that older approach will mean that your site goes down / becomes unavailable anytime you rebuild (yarn build:prod). To solve this issue:
- Create a separate
[dspace-ui-deploy]
location as described in the Installation documentation. - Copy the
[dspace-angular]/dist
folder to that location, as described in the Installation documentation. - Update your PM2 configuration or local startup scripts to use Node.js instead of Yarn. Again, see the Installation documentation.
- Create a separate
If upgrading from 7.0 or 7.1, migrate your UI Configurations to YAML. In 7.2, the format of the UI configuration file changed from Typescript to YAML to support runtime configuration. This means that customization of the older
./src/environment/environment.*.ts
build-time configuration files have all has been replaced superseded by corresponding corresponding./config/config.*.yml
configuration files (e.g. environment.prod.ts → config.prod.yml).- Either, manually move convert your "environment.prod.ts" configurations into to a new "./config/config.prod.yml" file, using the "./config/config.example.yml" as a guide, along with the User Interface Configuration documentation.
- OR, you can migrate your configurations using the provided "yarn env:yaml" migration script. For detailed instructions, see the Migrate environment file to YAML second of the User Interface Configuration documentation.
- (Optional) Review Configuration changes to see if you wish to update any new configurations
- In 7.1, we added the ability to "extend" themes in the "themes" section. See the User Interface Configuration documentation for details.
- In 7.2, themes now support optional "headTags" which can be used to customize favicons per theme (see User Interface Customization). Additionally, "browseBy > types" configurations were removed, as they are now dynamically retrieved from the REST API (see User Interface Configuration).
- In 7.3, you can optionally enable Item Access labels in the UI to display the status of an Item as a badge (e.g. "open access", "restricted", "metadata only" or "embargoed"). See User Interface Configuration
- In 7.4, many new user interface configurations were added. See Release Notes and User Interface Configuration for details.
- In 7.5, a new "Server Side Rendering" page caching option was added which can drastically speed up the initial response of your site. Other new settings also were added. See Release Notes and User Interface Configuration for details.
- Update your theme (if necessary), if you've created a custom theme in "src/themes" (or modified the existing "custom" or "dspace" themes in that location). Pay close attention to the following...
In 7.3, a new "eager-theme.module.ts" and "lazy-theme.module.ts" has been added to both the "custom" and "dspace" themes to improve performance. Make sure to copy those to your custom theme. Additionally, this new "eager-theme.module.ts" for your theme MUST be imported/enabled in "src/themes/eager-themes.module.ts". For example, for a local theme under "src/theme/my-theme":
Code Block title src/themes/eager-themes.module.ts import { EagerThemeModule as MyThemeEagerThemeModule } from './my-theme/eager-theme.module'; ... @NgModule({ imports: [ MyThemeEagerThemeModule, ], })
- Additional minor changes may have been made. It's usually best to look for changes to whichever theme you started from. If you started your theme from the "custom" theme, look for any new changes made under "/src/themes/custom". If you started your theme from the "dspace" theme, look for any new changes made under "/src/themes/dspace".
Using a tool like "git diff" from the commandline is often an easy way to see changes that occurred only in that directory.
Code Block # Example which will show all the changes to "src/themes/dspace" (and all subfolders) # between dspace-7.4 (tag) and dspace-7.5 (tag) git diff dspace-7.4 dspace-7.5 -- src/themes/dspace/
- For the "custom" theme, the largest changes are often:
- New themeable components (subdirectories) may be added under "src/themes/custom/app", allowing you the ability to now change the look & feel of those components.
- The "src/themes/custom/theme.module.ts" file will likely have minor updates. This file registers any new themeable components (in the "
const DECLARATIONS
" section), and also registers new Modules, i.e. new UI features, (in the "@NgModule
" → "imports" section). Make sure those sections are updated in your copy of this file! - Sometimes, new styles may be added in the "styles" folder, or new imports to "styles/theme.scss"
- If you have locally customized the styles or look & feel of any component, you should also verify that the component itself (in src/app) hasn't had updates.
- For the "dspace" theme, the largest changes are often:
- Existing customized components (subdirectories) under "src/themes/dspace/app/" may have minor updates, if improvements were made to that component.
- The "src/themes/custom/theme.module.ts" file will likely have minor updates. This file registers any new themeable components (in the "
const DECLARATIONS
" section), and also registers new Modules, i.e. new UI features, (in the "@NgModule
" → "imports" section). Make sure those sections are updated in your copy of this file! - Sometimes, new styles may be added in the "styles" folder, or new imports to "styles/theme.scss"
- If you have locally customized the styles or look & feel of any additional component, you should also verify that the component itself (in src/app) hasn't had updates.
- Restart the User Interface.
If you are using PM2 as described in the Installing DSpace instructions, you'd stop it and then start it back up as follows
Code Block # Stop the running UI pm2 stop dspace-ui.json # If you had to update your PM2 configs, you may need to delete your old configuration from PM2 # pm2 delete dspace-ui.json # Start it back up pm2 start dspace-ui.json
If you are using a different approach, you simply need to stop the running UI, and re-run:
Code Block # First stop the running UI process by killing it (or similar) # You MUST restart the UI from within the deployment directory # See Installation Instructions for more info on this directory cd [dspace-ui-deploy] # Then restart the UI via Node.js node ./dist/server/main.js
- Verify the UI and REST API are both working properly.
- If you hit errors, see the "Troubleshooting Upgrade Issues" section below. Additionally, check the "Common Installation Issues" section of the Installing DSpace documentation for other common misconfiguration or setup issues.
- Upgrade Node.js if necessary
...