This guide shows how to quickly install dspace 8 on Ubuntu 24.04 server for testing purposes. If you follow this guide to install a production server, please MAKE SURE to change the default passwords and other necessary security requirements for your system.
Hardware requirements: This guide was developed using a VPS server with the following specifications
8 GB Memory / 2 Intel vCPUs / 160 GB Disk / Ubuntu 24.04 (LTS) x64Setup Prerequisites
Create system user and group dspace and add to sudoers group
adduser dspaceusermod -aG sudo dspaceQuit root user and switch to dspace
su dspace && cdsudo apt update && sudo apt upgrade -yInstall DSpace 8 prerequisite packages
sudo apt install openjdk-17-jdk git ant ant-optional maven postgresql postgresql-contrib libpostgresql-jdbc-java zip npm nginx -yConfigure PostgresSQL Database
Set up host based access on PostgreSQL with the following command
echo "host dspace dspace 127.0.0.1/32 md5" | sudo tee -a /etc/postgresql/16/main/pg_hba.confChange database user permissions to “trust” only
sudo sed -i 's/ident/trust/' /etc/postgresql/16/main/pg_hba.confsudo sed -i 's/md5/trust/' /etc/postgresql/16/main/pg_hba.confsudo sed -i 's/peer/trust/' /etc/postgresql/16/main/pg_hba.confRestart postgres db
sudo systemctl restart postgresqlSwitch to postgres user
sudo su postgres && cdCreate dspace db user
createuser dspaceCreate the dspace db with UNICODE encoding
createdb dspace -E UNICODEAccess the db shell
psql -d dspaceCreate the pgcrypto extension to the dspace database
CREATE EXTENSION pgcrypto;Create the dspace user password
ALTER ROLE dspace WITH PASSWORD 'your-db-password';Give the dspace db user ownership of the dspace db.
ALTER DATABASE dspace OWNER TO dspace;Give necessary privileges to dspace user on the dspace database
GRANT ALL PRIVILEGES ON DATABASE dspace TO dspace;Quit the database shell
\qExit postgres user’s shell
exitRestart postgres
sudo systemctl restart postgresqlSETUP SOLR SEARCH ENGINE
Solr is the search engine behind dspace search functionality as well as statistics
Download solr 8
wget -c https://dlcdn.apache.org/lucene/solr/8.11.4/solr-8.11.4.tgzExtract the downloaded file
tar xvf solr-8.11.4.tgzInstall solr to the system
sudo bash solr-8.11.4/bin/install_solr_service.sh solr-8.11.4.tgzBy default, the script will install solr in /opt/solr with a symbolic link to /opt/solr-8.11.4. Therefore, solr data directory will be in /var/solr directory.
Install DSpace 8 Back-end
Download dspace 8 from github
wget -c https://github.com/DSpace/DSpace/archive/refs/tags/dspace-8.0.tar.gzExtract the downloaded archive
tar -zxvf dspace-8.0.tar.gzRename the extracted folder to dspace-backend
mv DSpace-dspace-8.0 dspace-backendDelete the downloaded archive
rm -f dspace-8.0.tar.gzAccess the back-end source code folder.
cd dspace-backendCreate local.cfg configuration file
cp dspace/config/local.cfg.EXAMPLE dspace/config/local.cfgLook for the following changes in local.cfg file and add or adjust them accordingly
dspace.dir=/opt/dspace-8/server
dspace.server.url = http://YOUR-SERVER-HOST/server
dspace.ui.url = http://YOUR-SERVER-HOST
solr.server = http://localhost:8983/solr
db.url = jdbc:postgresql://localhost:5432/dspace
db.username = dspace
db.password = dspace
### uncomment the following 2 lines to run dspace 8 on localhost:8080
# server.address=127.0.0.1
# server.port=8080Create the deployment folders and ensure they have the correct permissions.
sudo mkdir -p /opt/dspace-8/server && sudo mkdir -p /opt/dspace-8/clientsudo chown -R dspace:dspace /opt/dspace-8Compile the source code using maven
mvn packageWait for the following “BUILD SUCCESS” message. If it fails, you must troubleshoot and resolve the error before proceeding.
Access the compiled source code
cd dspace/target/dspace-installerDeploy the code to the deployment directory using ant
ant fresh_installLook out for the following “BUILD SUCCESSFUL” message. If there are errors, resolve them before proceeding.
Switch to the backend deployment directory
cd /opt/dspace-8/serverCopy solr cores
sudo cp -r solr/* /var/solr/data/Set proper permissions for the solr folders and files you just copied
sudo chown solr:solr -R /var/solr/dataRestart solr
sudo systemctl restart solrInitialize the database
bin/dspace database migrateCreate the backend service file with the following steps
Create dspace.service file
sudo nano /etc/systemd/system/dspace-backend.servicePaste the following into the file
[Unit]
Description=DSpace 8 Backend
After=network.target
[Service]
User=dspace
Group=dspace
ExecStart=/usr/bin/java -jar /opt/dspace-8/server/webapps/server-boot.jar
WorkingDirectory=/opt/dspace-8/server/webapps/
Restart=on-failure
Environment=JAVA_OPTS="-Xms512m -Xmx2048m"
Environment=DS_HOME=/opt/dspace-8/server
[Install]
WantedBy=multi-user.targetRestart systemd to apply the changes
sudo systemctl daemon-reloadEnable the backend service to auto-start at reboot
sudo systemctl enable dspace-backendStart the service
sudo systemctl start dspace-backendThe backend should now be accessible at http://YOUR-SERVER:8080/server. If not, check the status of dspace-backend.service and troubleshoot and fix any errors before proceeding to installation of the front-end.
Install DSpace 8 Angular Front-end
Get back to the system user’s home directory and download the front-end application from github
cd && wget -c https://github.com/DSpace/dspace-angular/archive/refs/tags/dspace-8.0.tar.gzExtract the archive
tar -zxvf dspace-8.0.tar.gzRename the source code folder
mv dspace-angular-dspace-8.0 dspace-frontendcd into the source code folder
cd dspace-frontendVerify your installed node version. You should have node version 18 or 20
node -vnpm -vInstall yarn and pm2
sudo npm install -g yarn pm2Install angular dependencies
yarn installBuild the front-end source code for production using yarn
yarn build:prodCopy dist folder to the deployment folder
cp -r dist /opt/dspace-8/client/Create a config folder
mkdir -p /opt/dspace-8/client/configCreate the production configuration file
cp config/config.example.yml /opt/dspace-8/client/config/config.prod.ymlConfigure angular to connect to the backend REST API as shown in the image below. Adjust ssl, host and port number settings according to your setup. Remember, SSL must be enabled in production mode.
Run the front-end using pm2
Ensure you are in the front-end deployment folder
cd /opt/dspace-8/clientCreate the file dspace-ui.json needed to use pm2
nano dspace-ui.jsonCopy-paste the following code to the file
{
"apps": [
{
"name": "dspace-ui",
"cwd": "/opt/dspace-8/client",
"script": "dist/server/main.js",
"instances": 4,
"exec_mode": "cluster",
"env": {
"NODE_ENV": "production"
}
}
]
}Start the front-end application
pm2 start dspace-ui.jsonUse nginx as a proxy to the applications
Edit nginx configuration file
sudo nano /etc/nginx/sites-available/defaultConfigure your server block as shown below
server {
listen 80;
server_name 143.198.126.21;
access_log /var/log/nginx/dspace-access.log;
error_log /var/log/nginx/dspace-error.log;
location /server {
# proxy_set_header X-Forwarded-Proto https;
proxy_set_header X-Forwarded-Host $server_name;
proxy_pass http://localhost:8080/server;
}
location / {
proxy_set_header X-Forwarded-Host $server_name;
proxy_set_header X-Forwarded-Server $server_name;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_pass http://localhost:4000/;
}
}In production mode, replace the IP address with your actual domain name and install SSL certificate.
Restart nginx
sudo systemctl restart nginx
Leave a Reply