All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
...
dspace-7.2
) 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]/config/config.prod.yml
. You may wish to use the config.example.yml
as a starting point. This config.prod.yml
file can be used to override any of the default configurations listed in the config.example.yml
(in that same directory). At a minimum this file MUST include a "rest" section (and may also include a "ui" section), similar to the following (keep in mind, you only need to include settings that you need to modify).
Code Block | ||||
---|---|---|---|---|
| ||||
# The "ui" section defines where you want Node.js to run/respond. It often is a *localhost* (non-public) URL, especially if you are using 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 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/public 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 nameSpace: /server |
NOTE: In 7.1 or 7.0, this configuration file uses a different syntax and should be created at [dspace-angular]/src/environments/environment.prod.ts
, based on the default settings in environment.common.ts
. An example of that older syntax can also be found below:
Code Block | ||
---|---|---|
| ||
export const environment = { // The "ui" section defines where you want Node.js to run/respond. It often is a *localhost* (non-public) URL, especially if you are using 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' } }; |
yarn config:check:rest
. This script will attempt a basic Node.js connection with the REST API configured in your "config.prod.yml" (or "environment.prod.ts" for 7.1 or 7.0) file and validate the response.yarn start
" and trying to access it via http://[mydspace.edu]:4000/
from your web browser. KEEP IN MIND, we highly recommend always using HTTPS for Production.config.example.yml
configuration file you can also copy them into this same file.Build the User Interface for Production. This uses your config.prod.yml
and the source code to create a compiled version of the UI in the [dspace-angular]/dist
folder
Code Block |
---|
yarn run build:prod |
environment.prod.ts
, then you will need to rebuild the UI application (i.e. rerun this"yarn run build:prod" command).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 | ||
---|---|---|
| ||
{ "apps": [ { "name": "dspace-angular", "cwd": "/home/dspace/dspace-angular", "script": "yarn", "args": "run serve:ssr", "interpreter": "none" } ] } |
yarn run serve:ssr.
This is the command that starts the app (after it was built using yarn run build:prod
)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 |
config.prod.yml
yarn start
(which is a simple build & deploy process for the UI). This command might provide a more specific error message to you, if PM2 is not giving enough information back.sudo apt install apache2
sudo en2mod proxy; sudo a2enmod proxy_http
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 config.prod.yml ProxyPass / http://localhost:4000/ ProxyPassReverse / http://localhost:4000/ </VirtualHost> |
[dspace-angular]/config/ssl/
folder and add a key.pem
and cert.pem
to that folder (they must have those exact names)...