Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. First, install the User Interface and ensure it is successfully running against the REST API Demo site.  See the instructions under Install the User Interface only (above).  Remember, you can choose to install this on the same machine as the REST API, or on an entirely different machine.
  2. Then, install the REST API.  The REST API installation process is very similar to the installation process for DSpace 6 or below (so if you are familiar with installing DSpace already, this will be familiar to you).
    1. Required Prerequisites for the DSpace 7 REST API are listed at Installing DSpace#PrerequisiteSoftware.  These include:
      1. Java JDK 8 (OpenJDK or Oracle). OpenJDK is recommended. (Note: Java 7 is no longer supported.)
      2. Apache Maven 3.3.x or above.
      3. Apache Ant 1.8 or above.
      4. Relational Database. Either PostgreSQL 9.4 (or above) or Oracle 10g (or above)
      5. Servlet Engine. Apache Tomcat 8 (or above) is recommended.
      6. Apache Solr 7.2.1 or above.  (NOTE: This is a new requirement for DSpace 7. You MUST install Solr separately from DSpace as it is no longer provided out-of-the-box.)
    2. Installation is very similar to that of DSpace 6.x.  Draft installation instructions for the DSpace 7 REST API are available at Installing DSpace#Installation
      1. Pay close attention to a new installation step (#11 in that list).  Because Solr is now a separate install, you need to copy the DSpace Solr core configurations into your Apache Solr installation location.
    3. If you have an existing test/demo version of DSpace 6.x locally, you can optionally choose to upgrade it to the DSpace 7 Preview Release.  DO NOT DO THIS IN PRODUCTION AS THE UPGRADE IS EXPERIMENTAL AT THIS TIME.
      1. Keep in mind, your old UI changes will not be upgraded as the XMLUI and JSPUI no longer exist in DSpace 7.  Therefore, only your data (in your database and assetstore) will be upgraded.
      2. To upgrade your data, Install the DSpace 7 REST API (as noted above) on top of a copy of your existing DSpace 6.x test/demo instance. We highly recommend doing this upgrade on a copy of your DSpace 6.x instance, as you cannot "undo" it. (NOTE: Make sure you are running a valid version of all prerequisites, and have installed Solr separately) 
      3. You will also need to perform step #11 in the Installation instructions (see above) in order to configure your Apache Solr installation properly.
      4. After you start up the DSpace 7 REST API, you will need to reindex all your content by running:  [dspace]/bin/dspace index-discovery -b 
        1. NOTE: At this time we are NOT yet able to upgrade DSpace 6.x (or below) Solr statistics.  A procedure for that upgrade will be coming in the future.
    4. Once it is running locally, your REST API should be available at: http://localhost:8080/spring-rest
      1. This assumes you are running Tomcat on port 8080 (which is its default port)
  3. Once both the User Interface and REST API are installed, you will need to point your locally running User Interface at your REST API
    1. In the locally installed dspace-angular project folder, modify the [dspace-angular]/config/environment.default.js configuration to point at your local REST API.  The below settings assume your REST API is available at http://localhost:8080/spring-rest 

      Code Block
      // The REST API server settings.
      rest: {
      ssl: false,
      host: 'localhost',
      port: 8080,
      // NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript
      nameSpace: '/spring-rest/api'
      }


    2. Alternatively, if you want, you can copy the "environment.default.js" to a new file called "environment.productionprod.js" and modify that new file.
    3. After the update is made, restart your User Interface by running: yarn start
  4. At this point your local UI should be using your local REST API
    1. User Interface: http://localhost:3000/
    2. REST API: https://localhost:8080/spring-rest/
    3. Admin Login:  You can create one on the REST API server by running [dspace]/bin/dspace create-administrator from the command-line (this same command was used in DSpace 6.x)

...