Page History
...
Installing the Backend (Server API)
Note | ||
---|---|---|
| ||
These installation instructions are a work-in-progress and based heavily on the DSpace 6.x installation instructions. Feedback or improvements are welcome. |
Backend Requirements
Table of Content Zone | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
UNIX-like OS or Microsoft Windows
Java JDK 11 (OpenJDK or Oracle JDK)
Apache Maven 3.3.x or above (Java build tool)Maven is necessary in the first stage of the build process to assemble the installation package for your DSpace instance. It gives you the flexibility to customize DSpace using the existing Maven projects found in the [dspace-source]/dspace/modules directory or by adding in your own Maven project to build the installation package for DSpace, and apply any custom interface "overlay" changes. Maven can be downloaded from http://maven.apache.org/download.html Configuring a Maven ProxyYou can configure a proxy to use for some or all of your HTTP requests in Maven. The username and password are only required if your proxy requires basic authentication (note that later releases may support storing your passwords in a secured keystore‚ in the meantime, please ensure your settings.xml file (usually ${user.home}/.m2/settings.xml) is secured with permissions appropriate for your operating system). Example:
Apache Ant 1.10.x or later (Java build tool)
Apache Ant is required for the second stage of the build process (deploying/installing the application). First, Maven is used to construct the installer ( Ant can be downloaded from the following location: http://ant.apache.org Relational Database (PostgreSQL or Oracle)PostgreSQLv1111 (with pgcrypto installed)
Oracle 10g or later
Apache Solr 8.xor later(full-text index/search service)
Solr can be obtained at the Apache Software Foundation site for Lucene and Solr. You may wish to read portions of the quick-start tutorial to make yourself familiar with Solr's layout and operation. Unpack a Solr .tgz or .zip archive in a place where you keep software that is not handled by your operating system's package management tools, and arrange to have it running whenever DSpace is running. You should ensure that Solr's index directories will have plenty of room to grow. You should also ensure that port 8983 is not in use by something else, or configure Solr to use a different port. If you are looking for a good place to put Solr, consider It is not necessary to dedicate a Solr instance to DSpace, if you already have one and want to use it. Simply copy DSpace's cores to a place where they will be discovered by Solr. See below. Servlet Engine (Apache Tomcat 9, Jetty, Caucho Resin or equivalent)
(Optional) IP to City Database for Location-based StatisticsOptionally, if you wish to record the geographic locations of clients in DSpace usage statistics records, you will need to install (and regularly update) one of the following:
Git (code version control)Currently, there is a known bug in DSpace where a third-party Maven Module expects
For the time being, you can work around this problem by installing Git locally: https://git-scm.com/downloads |
...
- Install all the Backend Requirements listed above.
Create a DSpace operating system user (optional) . As noted in the prerequisites above, Tomcat (or Jetty, etc) must run as an operating system user account that has full read/write access to the DSpace installation directory (i.e.
[dspace]
). Either you must ensure the Tomcat owner also owns[dspace]
, OR you can create a new "dspace" user account, and ensure that Tomcat also runs as that account:Code Block useradd -m dspace
- 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.0-beta5
) or branch. - Unpack the DSpace software. After downloading the software, based on the compression file format, choose one of the following methods to unpack your software:
Zip file. If you downloaded dspace-7.0-beta5.zip do the following:
Code Block unzip dspace-7.0-beta5.zip
.gz file. If you downloaded dspace-7.0-beta.tar.gz do the following:
Code Block gunzip -c dspace-7.0-beta5.tar.gz | tar -xf -
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. After unpacking the file, the user may wish to change the ownership of the dspace-7.x folder to the "dspace" user. (And you may need to change the group).
- Database Setup
- PostgreSQL:
Create a
dspace
database user (this user can have any name, but we'll assume you name them "dspace"). This is entirely separate from thedspace
operating-system user created above:Code Block createuser --username=postgres --no-superuser --pwprompt dspace
You will be prompted (twice) for a password for the new
dspace
user. Then you'll be prompted for the password of the PostgreSQL superuser (postgres
).Create a
dspace
database, owned by thedspace
PostgreSQL user. Similar to the previous step, this can only be done by a "superuser" account in PostgreSQL (e.g.postgres
):Code Block createdb --username=postgres --owner=dspace --encoding=UNICODE dspace
You will be prompted for the password of the PostgreSQL superuser (
postgres
).Finally, you MUST enable the pgcrypto extension on your new dspace database. Again, this can only be enabled by a "superuser" account (e.g.
postgres
)Code Block # Login to the database as a superuser, and enable the pgcrypto extension on this database psql --username=postgres dspace -c "CREATE EXTENSION pgcrypto;"
The "CREATE EXTENSION" command should return with no result if it succeeds. If it fails or throws an error, it is likely you are missing the required pgcrypto extension (see Database Prerequisites above).
Alternative method: How to enable pgcrypto via a separate database schema. While the above method of enabling pgcrypto is perfectly fine for the majority of users, there may be some scenarios where a database administrator would prefer to install extensions into a database schema that is separate from the DSpace tables. Developers also may wish to install pgcrypto into a separate schema if they plan to "clean" (recreate) their development database frequently. Keeping extensions in a separate schema from the DSpace tables will ensure developers would NOT have to continually re-enable the extension each time you run a "
./dspace database clean
". If you wish to install pgcrypto in a separate schema here's how to do that:Code Block # Login to the database as a superuser psql --username=postgres dspace # Create a new schema in this database named "extensions" (or whatever you want to name it) CREATE SCHEMA extensions; # Enable this extension in this new schema CREATE EXTENSION pgcrypto SCHEMA extensions; # Grant rights to call functions in the extensions schema to your dspace user GRANT USAGE ON SCHEMA extensions TO dspace; # Append "extensions" on the current session's "search_path" (if it doesn't already exist in search_path) # The "search_path" config is the list of schemas that Postgres will use SELECT set_config('search_path',current_setting('search_path') || ',extensions',false) WHERE current_setting('search_path') !~ '(^|,)extensions(,|$)'; # Verify the current session's "search_path" and make sure it's correct SHOW search_path; # Now, update the "dspace" Database to use the same "search_path" (for all future sessions) as we've set for this current session (i.e. via set_config() above) ALTER DATABASE dspace SET search_path FROM CURRENT;
- Oracle:
Setting up DSpace to use Oracle is a bit different now. You will need still need to get a copy of the Oracle JDBC driver, but instead of copying it into a lib directory you will need to install it into your local Maven repository. (You'll need to download it first from this location: http://www.oracle.com/technetwork/database/enterprise-edition/jdbc-112010-090769.html.) Run the following command (all on one line):
Code Block mvn install:install-file -Dfile=ojdbc6.jar -DgroupId=com.oracle -DartifactId=ojdbc6 -Dversion=11.2.0.4.0 -Dpackaging=jar -DgeneratePom=true
You need to compile DSpace with an Oracle driver (ojdbc6.jar) corresponding to your Oracle version - update the version in [dspace-source]/pom.xml E.g.:
Code Block language html/xml <dependency> <groupId>com.oracle</groupId> <artifactId>ojdbc6</artifactId> <version>11.2.0.4.0</version> </dependency>
- Create a database for DSpace. Make sure that the character set is one of the Unicode character sets. DSpace uses UTF-8 natively, and it is required that the Oracle database use the same character set. Create a user account for DSpace (e.g. dspace) and ensure that it has permissions to add and remove tables in the database.
NOTE: You will need to ensure the proper
db.*
settings are specified in yourlocal.cfg
file (see next step), as the defaults for all of these settings assuming a PostgreSQL database backend.Code Block db.url = jdbc:oracle:thin:@host:port/SID # e.g. db.url = jdbc:oracle:thin:@//localhost:1521/xe # NOTE: in db.url, SID is the SID of your database defined in tnsnames.ora # the default Oracle port is 1521 # You may also use a full SID definition, e.g. # db.url = jdbc:oracle:thin:@(description=(address_list=(address=(protocol=TCP)(host=localhost)(port=1521)))(connect_data=(service_name=DSPACE))) # Oracle driver and dialect db.driver = oracle.jdbc.OracleDriver db.dialect = org.hibernate.dialect.Oracle10gDialect # Specify DB username, password and schema to use db.username = db.password = db.schema = ${db.username} # For Oracle, schema is equivalent to the username of your database account, # so this may be set to ${db.username} in most scenarios
Later, during the Maven build step, don't forget to specify
mvn -Ddb.name=oracle package
- PostgreSQL:
- Initial Configuration (local.cfg): Create your own
[dspace-source]/dspace/config/local.cfg
configuration file (you may wish to simply copy the provided[dspace-source]/dspace/config/local.cfg.EXAMPLE
). This local.cfg file can be used to store any configuration changes that you wish to make which are local to your installation (see local.cfg configuration file documentation). ANY setting may be copied into this local.cfg file from the dspace.cfg or any other *.cfg file in order to override the default setting (see note below). For the initial installation of DSpace, there are some key settings you'll likely want to override, those are provided in the[dspace-source]/dspace/config/local.cfg.EXAMPLE
. (NOTE: Settings followed with an asterisk (*) are highly recommended, while all others are optional during initial installation and may be customized at a later time)dspace.dir*
- must be set to the [dspace] (installation) directory (NOTE: On Windows be sure to use forward slashes for the directory path! For example: "C:/dspace
" is a valid path for Windows.)dspace.server.url*
- complete URL of this DSpace backend (including port and any subpath). Do not end with '/'. For example: http://localhost:8080/serverdspace.ui.url*
- complete URL of the DSpace frontend (including port and any subpath). REQUIRED for the REST API to fully trust requests from the DSpace frontend. Do not end with '/'. For example: http://localhost:4000dspace.name
- Human-readable, "Properproper" name of your server, e.g. "My Digital Library".solr.server
* - complete URL of the Solr server. DSpace makes use of Solr for indexing purposes. http://localhost:8983/solr unless you changed the port or installed Solr on some other host.default.language -
Default language for all metadata values (defaults to "en_US")db.url* -
The full JDBC URL to your database (examples are provided in thelocal.cfg.EXAMPLE
)db.driver* -
Which database driver to use, based on whether you are using PostgreSQL or Oracledb.dialect* -
Which database dialect to use, based on whether you are using PostgreSQL or Oracledb.username
* - the database username used in the previous step.db.password
* - the database password used in the previous step.db.schema
* - the database scheme to use (examples are provided in the local.cfg.EXAMPLE)mail.server
- fully-qualified domain name of your outgoing mail server.mail.from.address
- the "From:" address to put on email sent by DSpace.mail.feedback.recipient
- mailbox for feedback mail.mail.admin
- mailbox for DSpace site administrator.alert.recipient
- mailbox for server errors/alerts (not essential but very useful!)registration.notify
- mailbox for emails when new users register (optional)Info title Your local.cfg file can override ANY settings from other *.cfg files in DSpace The provided
local.cfg.EXAMPLE
only includes a small subset of the configuration settings available with DSpace. It provides a good starting point for your ownlocal.cfg
file.However, you should be aware that ANY configuration can now be copied into your
local.cfg
to override the default settings. This includes ANY of the settings/configurations in:- The primary dspace.cfg file (
[dspace]/config/dspace.cfg
) - Any of the module configuration files (
[dspace]/config/modules/*.cfg
files) - Any of the Spring Boot settings (
[dspace-src]/dspace-server-webapp/src/main/resources/application.properties
)
Individual settings may also be commented out or removed in your
local.cfg
, in order to re-enable default settings.See the Configuration Reference section for more details.
- The primary dspace.cfg file (
DSpace Directory: Create the directory for the DSpace backend installation (i.e.
[dspace]
). As root (or a user with appropriate permissions), run:Code Block mkdir [dspace] chown dspace [dspace]
(Assuming the dspace UNIX username.)
Build the Installation Package: As the dspace UNIX user, generate the DSpace installation package.
Code Block cd [dspace-source] mvn package
Info title Building with Oracle Database Support Without any extra arguments, the DSpace installation package is initialized for PostgreSQL. If you want to use Oracle instead, you should build the DSpace installation package as follows:
mvn -Ddb.name=oracle package
Install DSpace Backend: As the dspace UNIX user, install DSpace to
[dspace]
:Code Block cd [dspace-source]/dspace/target/dspace-installer ant fresh_install
Info To see a complete list of build targets, run:
ant help
The most likely thing to go wrong here is the test of your database connection. See the 104566943 Common Installation Issues Section below for more details.- 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.Technique A. Tell your Tomcat/Jetty/Resin installation where to find your DSpace web application(s). As an example, in the directory
[tomcat]/conf/Catalina/localhost
you could add files similar to the following (but replace[dspace]
with your installation location):Code Block title DEFINE A CONTEXT PATH FOR DSpace Server webapp: server.xml <?xml version='1.0'?> <Context docBase="[dspace]/webapps/server"/>
The name of the file (not including the suffix ".xml") will be the name of the context, so for example
server.xml
defines the context athttp://host:8080/server
. To define the root context (http://host:8080/
), name that context's fileROOT.xml
. Optionally, you can also choose to install the old, deprecated "rest" webapp if you- Technique B. Simple and complete. You copy only (or all) of the DSpace Web application(s) you wish to use from the [dspace]/webapps directory to the appropriate directory in your Tomcat/Jetty/Resin installation. For example:
cp -R [dspace]/webapps/* [tomcat]/webapps*
(This will copy all the web applications to Tomcat).cp -R [dspace]/webapps/server [tomcat]/webapps*
(This will copy only the Server web application to Tomcat.)To define the root context (
http://host:8080/
), name that context's directoryROOT
.
- Optionally, also install the deprecated DSpace 6.x REST API web application. 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 frontend. So, most users should skip this step. Copy Solr cores: DSpace installation creates a set of four empty Solr cores already configured. Copy them from
[dspace]
/solr to the place where your Solr instance will discover them. Start (or re-start) Solr. For example:Code Block language bash cp -R [dspace]/solr/* [solr]/server/solr/configsets [solr]/bin/solr restart
You can check the status of Solr and your new DSpace cores by using its administrative web interface. Browse tohttp://localhost:8983/
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.Create an Administrator Account: Create an initial administrator account from the command line:
Code Block [dspace]/bin/dspace create-administrator
- Initial Startup! Now the moment of truth! Start up (or restart) Tomcat/Jetty/Resin.
- REST API Interface - (e.g.) http://dspace.myu.edu:8080/server/
- OAI-PMH Interface - (e.g.) http://dspace.myu.edu:8080/server/oai/request?verb=Identify
- For an example of what the default backend looks like, visit the Demo Backend: https://api7.dspace.org/server/
- Production Installation (adding HTTPS support): Running the DSpace Backend on HTTP & port 8080 is only usable for testing/demo environments. If you want to run DSpace in Production, you MUST run the backend with HTTPS support (otherwise logins will not work outside of your local domain).
- For HTTPS support, we recommend installing either Apache HTTPD or Nginx, configuring SSL at that level, and proxying all requests to your Tomcat installation (on port 8080). Keep in mind, if you want to host both the DSpace Backend and Frontend on the same server, you can use one installation of Apache HTTPD or Nginx to manage HTTPS/SSL and proxy to both.
- These instructions are specific to Apache HTTPD, but a similar setup can be achieved with Nginx
- Install Apache HTTPD, e.g.
sudo apt install apache2
- Install the mod_proxy and mod_proxy_ajp modules, e.g.
sudo en2mod proxy; sudo a2enmod proxy_ajp
Alternatively, you can choose to use mod_proxy_http to create an http proxy. A separate example is commented out below
- Restart Apache to enable
For mod_proxy_ajp to communicate with Tomcat, you'll need to enable Tomcat's AJP connector in your Tomcat's server.xml:
Code Block <Connector protocol="AJP/1.3" port="8009" redirectPort="8443" URIEncoding="UTF-8" />
Now, setup a new VirtualHost for your site (using HTTPS / port 443) which proxies all requests to Tomcat's AJP connector (running on port 8009)
Code Block <VirtualHost _default_:443> .. setup your host how you want, including log settings... SSLEngine on SSLCertificateFile [full-path-to-PEM-cert] SSLCertificateKeyFile [full-path-to-cert-KEY] # Proxy all HTTPS requests to "/server" from Apache to Tomcat via AJP connector ProxyPass /server ajp://localhost:8009/server ProxyPassReverse /server ajp://localhost:80009/server # If you would rather use mod_proxy_http as an http proxy to port 8080 # then use these settings instead #ProxyPass /server http://localhost:8080/server #ProxyPassReverse /server http://localhost:8080/server # When using mod_proxy_http, you need to also ensure the X-Forwarded-Proto header is sent # to tell DSpace it is behind HTTPS, otherwise some URLs may continue to use HTTP $# (requires installing/enabling mod_headers) #RequestHeader set X-Forwarded-Proto https </VirtualHost>
- Install Apache HTTPD, e.g.
- After switching to HTTPS, make sure to go back and update the URLs (e.g.
dspace.server.url
) in your local.cfg to match the new URL of your backend. This will require briefly rebooting Tomcat.
Installing the Frontend (User Interface)
Note | ||
---|---|---|
| ||
These installation instructions are a work-in-progress. They do NOT yet include production Link -ready installation scenarios for running the (Angular) frontend via production tools like PM2 or Passenger. Feedback or improvements are welcome. |
Frontend Requirements
Frontend Requirements
Table of Content Zone | ||||
---|---|---|---|---|
| ||||
UNIX-like OS or Microsoft Windows
| ||||
Table of Content Zone | ||||
| ||||
UNIX-like OS or Microsoft Windows
Node.js (v12.x or v14.x)
Yarn (v1.x)
PM2 (or another Process Manager for Node.js apps) (optional, but recommended for Production)
DSpace 7.x Backend (see above)
|
...
- First, install all the Frontend Requirements listed above & verify the backend/REST API is publicly accessible.
- 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.0-beta5
) or branch. Install all necessary local dependencies by running the following from within the unzipped "dspace-angular" directory
Code Block # change directory to our repo cd dspace-angular # install the local dependencies yarn install
Create a Production Configuration file at
[dspace-angular]/src/environments/environment.prod.ts
. You may wish to use theenvironment.template.ts
as a starting point. Thisenvironment.prod.ts
file can be used to override any of the default configurations specified in theenvironment.common.ts
(in that same directory). At a minimum this file MUST include the "ui" and "rest" sections similar to the following (keep in mind, you only need to include settings that you need to modify):Code Block export const environment = { // The "ui" section defines where you want Node.js to run/respond. It may correspond to your primary URL, but it also may not (if you are running behind a proxy). // In this example, we are setting up our UI to just use localhost, port 4000. // This is a common setup for when you want to use Apache or Nginx to handle HTTPS and proxy requests to Node on port 4000 ui: { ssl: false, host: 'localhost', port: 4000, // NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript nameSpace: '/' }, // This example is valid if your Backend is publicly available at https://api.mydspace.edu/server/ // The REST settings MUST correspond to the primary URL of the backend. Usually, this means they must be kept in sync // with the value of "dspace.server.url" in the backend's local.cfg rest: { ssl: true, host: 'api.mydspace.edu', port: 443, // NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript nameSpace: '/server' } };
- HINT #1: In the "ui" section above, you may wish to start with "ssl: false" and "port: 4000" just to be certain that everything else is working properly. With those settings, you can quickly test your UI by running "
yarn start
" and trying to access it viahttp://[mydspace.edu]:4000/
from your web browser. KEEP IN MIND, we highly recommend always using HTTPS for Production. - HINT #2: If Node throws an error saying "listen EADDRNOTAVAIL: address not available", try setting the "host" to "0.0.0.0" or "localhost". Usually that error is a sign that the "host" is not recognized.
- If there are other settings you know you need to modify in the default
environment.common.ts
configuration file you can also copy them into this same file.
- HINT #1: In the "ui" section above, you may wish to start with "ssl: false" and "port: 4000" just to be certain that everything else is working properly. With those settings, you can quickly test your UI by running "
Build the User Interface for Production. This uses your
environment.prod.ts
and the source code to create a compiled version of the UI in the[dspace-angular]/dist
folderCode Block yarn run build:prod
- HINT: if you change/update your
environment.prod.ts
, then you will need to rebuild the UI application (i.e. rerun this command).
- HINT: if you change/update your
Assuming you are using PM2, create a JSON configuration file describing how to run our UI application. This need NOT be in the same directory as the dspace-angular codebase itself (in fact you may want to put the parent directory or another location). Keep in mind the "cwd" setting (on line 5) must be the full path to your
[dspace-angular]
folder.Code Block title dspace-angular.json { "apps": [ { "name": "dspace-angular", "cwd": "/home/dspace/dspace-angular", "script": "yarn", "args": "run serve:ssr", "interpreter": "none" } ] }
Now, start the application using PM2 using the configuration file you created in the previous step
Code Block # In this example, we are assuming the config is named "dspace-angular.json" pm2 start dspace-angular.json # To see the logs, you'd run # pm2 logs # To stop it, you'd run # pm2 stop dspace-angular.json
- For more PM2 commands see https://pm2.keymetrics.io/docs/usage/quick-start/
- HINT: You may also want to install/configure pm2-logrotate to ensure that PM2's log folder doesn't fill up over time.
- At this point, the User Interface should be available at the URL you configured in your
environment.prod.ts
- For an example of what the default frontend looks like, visit the Demo Frontend: https://demo7.dspace.org/
- For HTTPS (port 443) support, you have two options
- (Recommended) You can install either Apache HTTPD or Nginx , configuring SSL at that level, and proxy requests to PM2 (on port 4000). This is our current recommended approach. Plus, as a bonus, if you want to host the UI and Backend on the same server, you can use just one Apache HTTPD (or Nginx) to proxy to both. These instructions are specific to Apache.
- Install Apache HTTPD, e.g.
sudo apt install apache2
- Install the mod_proxy and mod_proxy_http modules, e.g.
sudo en2mod proxy; sudo a2enmod proxy_http
- Restart Apache to enable
Now, setup a new VirtualHost for your site (preferably using HTTPS / port 443) which proxies all requests to PM2 running on port 4000.
Code Block <VirtualHost _default_:443> .. setup your host how you want, including log settings... SSLEngine on SSLCertificateFile [full-path-to-PEM-cert] SSLCertificateKeyFile [full-path-to-cert-KEY] # Proxy all HTTPS requests from Apache to PM2 on port 4000 # NOTE that this proxy URL must match the "ui" settings in your environment.*.ts ProxyPass / http://localhost:4000/ ProxyPassReverse / http://localhost:4000/ </VirtualHost>
- Install Apache HTTPD, e.g.
- (Alternatively) You can use the basic HTTPS support built into dspace-angular node server. (This may currently be better for non-Production environments as it has not been well tested)
- Create a
[dspace-angular]/config/ssl/
folder and add akey.pem
andcert.pem
to that folder (they must have those exact names) - Enable "ui.ssl" (set to true)
- Update your "ui.port" to be 443
- In order to run Node/PM2 on port 443, you also will likely need to provide node with special permissions, like in this example.
- Rebuild and then restart the app in PM2
- Keep in mind, while this setup is simple, you may not have the same level of detailed, Production logs as you would with Apache HTTPD or Nginx
- Create a
- (Recommended) You can install either Apache HTTPD or Nginx , configuring SSL at that level, and proxy requests to PM2 (on port 4000). This is our current recommended approach. Plus, as a bonus, if you want to host the UI and Backend on the same server, you can use just one Apache HTTPD (or Nginx) to proxy to both. These instructions are specific to Apache.
- Additional UI configurations are described in the environment.common.ts and at https://github.com/DSpace/dspace-angular/blob/main/docs/Configuration.md (More documentation will be coming soon)
...
In general, when running behind a proxy, the DSpace REST API depends on accurate X-Forwarded-* headers to be sent by that proxy.
Database errors occur when you run ant fresh_install
There are two common errors that occur.
If your error looks like this:
Code Block language text [java] 2004-03-25 15:17:07,730 INFO org.dspace.storage.rdbms.InitializeDatabase @ Initializing Database [java] 2004-03-25 15:17:08,816 FATAL org.dspace.storage.rdbms.InitializeDatabase @ Caught exception: [java] org.postgresql.util.PSQLException: Connection refused. Check that the hostname and port are correct and that the postmaster is accepting TCP/IP connections. [java] at org.postgresql.jdbc1.AbstractJdbc1Connection.openConnection(AbstractJd bc1Connection.java:204) [java] at org.postgresql.Driver.connect(Driver.java:139)
it usually means you haven't yet added the relevant configuration parameter to your PostgreSQL configuration (see above), or perhaps you haven't restarted PostgreSQL after making the change. Also, make sure that the db.username and db.password properties are correctly set in [dspace]/config/dspace.cfg. An easy way to check that your DB is working OK over TCP/IP is to try this on the command line:
Code Block psql -U dspace -W -h localhost
Enter the dspace database password, and you should be dropped into the psql tool with a dspace=> prompt.
Another common error looks like this:
Code Block language text [java] 2004-03-25 16:37:16,757 INFO org.dspace.storage.rdbms.InitializeDatabase @ Initializing Database [java] 2004-03-25 16:37:17,139 WARN org.dspace.storage.rdbms.DatabaseManager @ Exception initializing DB pool [java] java.lang.ClassNotFoundException: org.postgresql.Driver [java] at java.net.URLClassLoader$1.run(URLClassLoader.java:198) [java] at java.security.AccessController.doPrivileged(Native Method) [java] at java.net.URLClassLoader.findClass(URLClassLoader.java:186)
This means that the PostgreSQL JDBC driver is not present in [dspace]/lib. See above.