Complete DSpace Installation Guide
Installation of Backend
Step 1: System Preparation
i. Update & Upgrade System Packages
sudo apt update && sudo apt upgrade -y
Purpose: Update and upgrade system packages
Explanation: This command updates the package lists and upgrades all installed packages to their latest versions. The -y flag automatically confirms the upgrade process.
Explanation: This command updates the package lists and upgrades all installed packages to their latest versions. The -y flag automatically confirms the upgrade process.
Step 2: Install Required Dependencies
i. Core Tools
sudo apt install wget curl git build-essential unzip zip -y
Purpose: Install core development tools
Explanation: This command installs essential tools needed for software development and system administration, including wget for downloading files, curl for transferring data, git for version control, and build tools for compiling software.
Explanation: This command installs essential tools needed for software development and system administration, including wget for downloading files, curl for transferring data, git for version control, and build tools for compiling software.
ii. Java Development Kit (OpenJDK 17)
sudo apt install openjdk-17-jdk -y
Purpose: Install Java Development Kit
Explanation: This command installs OpenJDK 17, which is required for running DSpace. DSpace is a Java-based application that requires a Java Runtime Environment.
Explanation: This command installs OpenJDK 17, which is required for running DSpace. DSpace is a Java-based application that requires a Java Runtime Environment.
iii. Verify Java Installation:
# Should show OpenJDK 17
java -version
Purpose: Verify Java installation
Explanation: This command displays the installed Java version, confirming that OpenJDK 17 was installed correctly.
Explanation: This command displays the installed Java version, confirming that OpenJDK 17 was installed correctly.
iv. Set the Environment Variable
## Set JAVA_HOME
sudo nano /etc/environment
Purpose: Edit environment variables file
Explanation: This command opens the system environment variables file for editing, where we'll add Java-specific configuration.
Explanation: This command opens the system environment variables file for editing, where we'll add Java-specific configuration.
Add the following two lines to the file
JAVA_HOME="/usr/lib/jvm/java-17-openjdk-amd64"
Purpose: Set JAVA_HOME environment variable
Explanation: This line sets the JAVA_HOME variable to point to the Java installation directory, which is needed by many Java applications.
Explanation: This line sets the JAVA_HOME variable to point to the Java installation directory, which is needed by many Java applications.
JAVA_OPTS="-Xmx512M -Xms64M -Dfile.encoding=UTF-8"
Purpose: Set Java runtime options
Explanation: This line configures Java memory settings (maximum heap size of 512MB, initial heap size of 64MB) and sets UTF-8 encoding for proper character handling.
Explanation: This line configures Java memory settings (maximum heap size of 512MB, initial heap size of 64MB) and sets UTF-8 encoding for proper character handling.
Apply changes, Save and close the editor, and apply the following command
source /etc/environment
Purpose: Reload environment variables
Explanation: This command applies the changes made to the environment variables file to the current shell session.
Explanation: This command applies the changes made to the environment variables file to the current shell session.
echo $JAVA_HOME
Purpose: Verify JAVA_HOME variable
Explanation: This command displays the value of the JAVA_HOME environment variable to confirm it was set correctly.
Explanation: This command displays the value of the JAVA_HOME environment variable to confirm it was set correctly.
echo $JAVA_OPTS
Purpose: Verify JAVA_OPTS variable
Explanation: This command displays the value of the JAVA_OPTS environment variable to confirm it was set correctly.
Explanation: This command displays the value of the JAVA_OPTS environment variable to confirm it was set correctly.
v. Build Tools (Maven & Ant)
sudo apt install maven ant -y
Purpose: Install build tools
Explanation: This command installs Maven and Ant, which are build automation tools used to compile and package DSpace.
Explanation: This command installs Maven and Ant, which are build automation tools used to compile and package DSpace.
# Verify Apache Maven Installation, Should show Apache Maven 3.x.x
mvn -version
Purpose: Verify Maven installation
Explanation: This command displays the installed Maven version, confirming that Maven was installed correctly.
Explanation: This command displays the installed Maven version, confirming that Maven was installed correctly.
# Verify Apache Ant Installation, Should show Apache Ant 1.10.x
ant -version
Purpose: Verify Ant installation
Explanation: This command displays the installed Ant version, confirming that Ant was installed correctly.
Explanation: This command displays the installed Ant version, confirming that Ant was installed correctly.
Step 3: Install PostgreSQL
sudo apt install postgresql postgresql-contrib libpostgresql-jdbc-java -y
Purpose: Install PostgreSQL database
Explanation: This command installs PostgreSQL database server, additional contributed packages, and the Java JDBC driver for PostgreSQL connectivity.
Explanation: This command installs PostgreSQL database server, additional contributed packages, and the Java JDBC driver for PostgreSQL connectivity.
i. Configure PostgreSQL
sudo -u postgres psql
Purpose: Access PostgreSQL as postgres user
Explanation: This command switches to the postgres system user and starts the PostgreSQL interactive terminal (psql).
Explanation: This command switches to the postgres system user and starts the PostgreSQL interactive terminal (psql).
ii. Run the following command to setup the database for DSpace
## Creates a PostgreSQL user (role) named dspace with the specified password
CREATE USER dspace WITH PASSWORD 'dspace';
Purpose: Create DSpace database user
Explanation: This SQL command creates a new PostgreSQL user named 'dspace' with the password 'dspace' that will be used by the DSpace application.
Explanation: This SQL command creates a new PostgreSQL user named 'dspace' with the password 'dspace' that will be used by the DSpace application.
## Creates a database named dspace and assigns ownership to the dspace user
CREATE DATABASE dspace WITH OWNER dspace;
Purpose: Create DSpace database
Explanation: This SQL command creates a new database named 'dspace' and assigns ownership to the 'dspace' user created in the previous step.
Explanation: This SQL command creates a new database named 'dspace' and assigns ownership to the 'dspace' user created in the previous step.
## Exits the PostgreSQL interactive terminal (psql)
\q
Purpose: Exit PostgreSQL terminal
Explanation: This command exits the PostgreSQL interactive terminal and returns to the regular shell prompt.
Explanation: This command exits the PostgreSQL interactive terminal and returns to the regular shell prompt.
iii. Enable pgcrypto Extension
sudo -u postgres psql dspace -c "CREATE EXTENSION pgcrypto;"
Purpose: Enable cryptographic functions
Explanation: This command enables the pgcrypto extension in the dspace database, which provides cryptographic functions that DSpace uses for secure operations.
Explanation: This command enables the pgcrypto extension in the dspace database, which provides cryptographic functions that DSpace uses for secure operations.
iv. Update and Configuration network access
Allow PostgreSQL to accept local connections from DSpace. This enables PostgreSQL to listen on localhost (for security, it won't accept external connections). DSpace (running locally) needs to communicate with PostgreSQL via TCP/IP.
sudo nano /etc/postgresql/16/main/postgresql.conf
Purpose: Edit PostgreSQL configuration
Explanation: This command opens the main PostgreSQL configuration file for editing to configure network listening settings.
Explanation: This command opens the main PostgreSQL configuration file for editing to configure network listening settings.
Locate the line (around line 60) under CONNECTIONS AND AUTHENTICATION:
#listen_addresses = 'localhost'
Purpose: Find listen_addresses setting
Explanation: This is the default commented-out line that needs to be uncommented and modified to allow PostgreSQL to listen on localhost.
Explanation: This is the default commented-out line that needs to be uncommented and modified to allow PostgreSQL to listen on localhost.
Uncomment it by removing #
listen_addresses = 'localhost'
Purpose: Configure PostgreSQL to listen on localhost
Explanation: This line configures PostgreSQL to listen for connections on the localhost interface only, enhancing security while allowing local applications to connect.
Explanation: This line configures PostgreSQL to listen for connections on the localhost interface only, enhancing security while allowing local applications to connect.
v. Configure Client Authentication (pg_hba.conf)
Allow the dspace user to authenticate with a password. This allows the dspace user to connect to the dspace database from localhost using password authentication (md5).
sudo nano /etc/postgresql/16/main/pg_hba.conf
Purpose: Edit PostgreSQL client authentication
Explanation: This command opens the PostgreSQL client authentication configuration file to set up access rules for the dspace database user.
Explanation: This command opens the PostgreSQL client authentication configuration file to set up access rules for the dspace database user.
Find the section starting with (line number 118):
# Database administrative login by Unix domain socket
Purpose: Locate authentication section
Explanation: This comment marks the section where authentication rules are defined in the pg_hba.conf file.
Explanation: This comment marks the section where authentication rules are defined in the pg_hba.conf file.
Add these lines below it:
#DSpace configuration
Purpose: Add configuration comment
Explanation: This comment helps identify the DSpace-specific configuration in the authentication file.
Explanation: This comment helps identify the DSpace-specific configuration in the authentication file.
host dspace dspace 127.0.0.1 255.255.255.255 md5
Purpose: Configure DSpace database access
Explanation: This line allows the dspace user to connect to the dspace database from localhost (127.0.0.1) using password authentication (md5).
Explanation: This line allows the dspace user to connect to the dspace database from localhost (127.0.0.1) using password authentication (md5).
vi. Restart PostgreSQL
sudo systemctl restart postgresql
Purpose: Restart PostgreSQL service
Explanation: This command restarts the PostgreSQL service to apply all the configuration changes made to the postgresql.conf and pg_hba.conf files.
Explanation: This command restarts the PostgreSQL service to apply all the configuration changes made to the postgresql.conf and pg_hba.conf files.
Step 4: Install Solr 9.x
## Download latest Solr 9.x Package and saves the file directly to /opt directory
sudo wget https://downloads.apache.org/solr/solr/9.9.0/solr-9.9.0.tgz -P /opt
Purpose: Download Apache Solr
Explanation: This command downloads the Solr 9.9.0 package from the Apache mirrors and saves it to the /opt directory.
Explanation: This command downloads the Solr 9.9.0 package from the Apache mirrors and saves it to the /opt directory.
## Extract the Archive
sudo tar xzf /opt/solr-9.9.0.tgz -C /opt
Purpose: Extract Solr package
Explanation: This command extracts the downloaded Solr archive to the /opt directory.
Explanation: This command extracts the downloaded Solr archive to the /opt directory.
## Rename Directory (Cleanup)
sudo mv /opt/solr-9.9.0 /opt/solr
Purpose: Rename Solr directory
Explanation: This command renames the extracted directory to a simpler name for easier reference.
Explanation: This command renames the extracted directory to a simpler name for easier reference.
## Remove Downloaded Archive
sudo rm /opt/solr-9.9.0.tgz
Purpose: Clean up downloaded file
Explanation: This command removes the downloaded archive file to free up disk space after extraction.
Explanation: This command removes the downloaded archive file to free up disk space after extraction.
## Create Dedicated Solr User
sudo useradd -r -d /opt/solr -M solr
Purpose: Create system user for Solr
Explanation: This command creates a dedicated system user for running Solr with the home directory set to /opt/solr.
Explanation: This command creates a dedicated system user for running Solr with the home directory set to /opt/solr.
## Set Ownership Permissions to solr directory
sudo chown -R solr:solr /opt/solr
Purpose: Set Solr directory ownership
Explanation: This command changes ownership of the Solr directory to the solr user, ensuring proper permissions for operation.
Explanation: This command changes ownership of the Solr directory to the solr user, ensuring proper permissions for operation.
## Create Systemd Service
sudo nano /etc/systemd/system/solr.service
Purpose: Create Solr service file
Explanation: This command creates a systemd service file to manage Solr as a system service.
Explanation: This command creates a systemd service file to manage Solr as a system service.
Paste the below content and save the file
[Unit]
Description=Apache Solr for DSpace
After=network.target
[Service]
User=solr
Group=solr
WorkingDirectory=/opt/solr
Environment="SOLR_OPTS=-Dsolr.config.lib.enabled=true -Djava.security.manager=allow"
Environment="SOLR_JETTY_HOST=0.0.0.0"
ExecStart=/opt/solr/bin/solr start -f
ExecStop=/opt/solr/bin/solr stop
Restart=on-failure
LimitNOFILE=65536
TimeoutSec=180
[Install]
WantedBy=multi-user.target
Purpose: Solr service configuration
Explanation: This systemd service configuration defines how Solr should run, including the user, environment variables, and execution commands.
Explanation: This systemd service configuration defines how Solr should run, including the user, environment variables, and execution commands.
## Reload systemd solr service and enable and start the solr:
sudo systemctl daemon-reload
Purpose: Reload systemd configuration
Explanation: This command reloads the systemd manager configuration to recognize the new Solr service.
Explanation: This command reloads the systemd manager configuration to recognize the new Solr service.
sudo systemctl enable --now solr
Purpose: Enable and start Solr service
Explanation: This command enables Solr to start at boot and starts the service immediately.
Explanation: This command enables Solr to start at boot and starts the service immediately.
sudo systemctl start solr
Purpose: Start Solr service
Explanation: This command starts the Solr service (redundant with --now flag but included for completeness).
Explanation: This command starts the Solr service (redundant with --now flag but included for completeness).
## Verify Installation
sudo systemctl status solr
Purpose: Check Solr service status
Explanation: This command displays the current status of the Solr service to verify it's running properly.
Explanation: This command displays the current status of the Solr service to verify it's running properly.
## Secure Solr for Production (Localhost Only)
Once testing is complete and DSpace is fully integrated with Solr, you should restrict Solr to listen only on localhost. This is critical to protect the Solr admin panel and prevent unauthorized access.
sudo nano /etc/systemd/system/solr.service
Purpose: Edit Solr service for production
Explanation: This command opens the Solr service file to modify it for production security.
Explanation: This command opens the Solr service file to modify it for production security.
Paste the below content and save the file
[Unit]
Description=Apache Solr for DSpace
After=network.target
[Service]
User=solr
Group=solr
WorkingDirectory=/opt/solr
Environment="SOLR_OPTS=-Dsolr.config.lib.enabled=true -Djava.security.manager=allow"
Environment="SOLR_HOST=127.0.0.1"
Environment="SOLR_PORT=8983"
Environment="SOLR_HEAP=512m"
ExecStart=/opt/solr/bin/solr start -f
ExecStop=/opt/solr/bin/solr stop
Restart=on-failure
LimitNOFILE=65536
TimeoutSec=180
[Install]
WantedBy=multi-user.target
Purpose: Production Solr configuration
Explanation: This configuration restricts Solr to listen only on localhost (127.0.0.1) for security and sets memory limits.
Explanation: This configuration restricts Solr to listen only on localhost (127.0.0.1) for security and sets memory limits.
## Reload systemd and restart Solr
sudo systemctl daemon-reload
Purpose: Reload systemd configuration
Explanation: This command reloads systemd to apply the modified Solr service configuration.
Explanation: This command reloads systemd to apply the modified Solr service configuration.
sudo systemctl restart solr
Purpose: Restart Solr with new configuration
Explanation: This command restarts Solr to apply the security changes (listening on localhost only).
Explanation: This command restarts Solr to apply the security changes (listening on localhost only).
## Verify Installation
sudo systemctl status solr
Purpose: Verify Solr is running
Explanation: This command checks that Solr is running properly with the new security configuration.
Explanation: This command checks that Solr is running properly with the new security configuration.
Step 5: Install Tomcat 10.x
sudo apt install tomcat10 -y
Purpose: Install Apache Tomcat
Explanation: This command installs Apache Tomcat 10, which will host the DSpace web applications.
Explanation: This command installs Apache Tomcat 10, which will host the DSpace web applications.
## Once installed, you can check the service status:
sudo systemctl status tomcat10
Purpose: Check Tomcat status
Explanation: This command displays the status of the Tomcat service to verify it was installed correctly.
Explanation: This command displays the status of the Tomcat service to verify it was installed correctly.
## Set File Permissions for Deployment
sudo chown -R tomcat:tomcat /dspace
Purpose: Set DSpace directory ownership
Explanation: This command changes ownership of the DSpace directory to the Tomcat user, allowing Tomcat to read and write to it.
Explanation: This command changes ownership of the DSpace directory to the Tomcat user, allowing Tomcat to read and write to it.
## Configure Java Options (/etc/default/tomcat10)
sudo nano /etc/default/tomcat10
Purpose: Edit Tomcat environment settings
Explanation: This command opens the Tomcat environment configuration file to set Java options.
Explanation: This command opens the Tomcat environment configuration file to set Java options.
Change this line:
JAVA_OPTS="-Djava.awt.headless=true"
Purpose: Default Java options
Explanation: This is the default Java options setting that needs to be modified for DSpace.
Explanation: This is the default Java options setting that needs to be modified for DSpace.
To: Add/update:
JAVA_OPTS="-Xmx2G -Xms512M -Dfile.encoding=UTF-8 -Djava.awt.headless=true"
Purpose: Configure Java memory settings
Explanation: This sets Java heap memory to 2GB maximum, 512MB initial, with UTF-8 encoding for proper character handling.
Explanation: This sets Java heap memory to 2GB maximum, 512MB initial, with UTF-8 encoding for proper character handling.
## Update Systemd Service for Write Permissions (/lib/systemd/system/tomcat10.service)
Tomcat's systemd unit needs permission to write to certain paths.
sudo nano /lib/systemd/system/tomcat10.service
Purpose: Edit Tomcat service file
Explanation: This command opens the Tomcat systemd service file to add write permissions.
Explanation: This command opens the Tomcat systemd service file to add write permissions.
Add in the last under [Service] section:
ReadWritePaths=/dspace
Purpose: Add write permissions for DSpace
Explanation: This line grants Tomcat write access to the /dspace directory, which is needed for DSpace operations.
Explanation: This line grants Tomcat write access to the /dspace directory, which is needed for DSpace operations.
## Configure Tomcat to Use UTF-8 Encoding (Connector on Port 8080)
To ensure your web application can properly handle international characters, you need to configure Tomcat to use UTF-8 encoding on its main HTTP connector.
sudo nano /etc/tomcat10/server.xml
Purpose: Edit Tomcat server configuration
Explanation: This command opens the main Tomcat configuration file to modify the HTTP connector.
Explanation: This command opens the main Tomcat configuration file to modify the HTTP connector.
Locate the Connector Section around line 68:
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443"
maxParameterCount="1000"
/>
Purpose: Default HTTP connector
Explanation: This is the default HTTP connector configuration that needs to be modified for UTF-8 support.
Explanation: This is the default HTTP connector configuration that needs to be modified for UTF-8 support.
Comment out the existing block by wrapping it with <!-- -->:
<!-- <Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443"
maxParameterCount="1000"
/> -->
Purpose: Comment out default connector
Explanation: This comments out the default HTTP connector to replace it with a customized version.
Explanation: This comments out the default HTTP connector to replace it with a customized version.
Add a customized connector block with UTF-8 encoding:
<Connector port="8080"
minSpareThreads="25"
enableLookups="false"
redirectPort="8443"
connectionTimeout="20000"
disableUploadTimeout="true"
URIEncoding="UTF-8"/>
Purpose: Configure UTF-8 HTTP connector
Explanation: This custom HTTP connector configuration enables UTF-8 encoding for proper international character support.
Explanation: This custom HTTP connector configuration enables UTF-8 encoding for proper international character support.
## Reload systemd and restart Tomcat
sudo systemctl daemon-reload
Purpose: Reload systemd configuration
Explanation: This command reloads systemd to apply the Tomcat service changes.
Explanation: This command reloads systemd to apply the Tomcat service changes.
sudo systemctl restart tomcat10
Purpose: Restart Tomcat
Explanation: This command restarts Tomcat to apply all configuration changes.
Explanation: This command restarts Tomcat to apply all configuration changes.
## Verify tomcat10 service status
sudo systemctl status tomcat10
Purpose: Verify Tomcat is running
Explanation: This command checks that Tomcat is running properly with the new configuration.
Explanation: This command checks that Tomcat is running properly with the new configuration.
Step 6: Create a dedicated DSpace User
For security reasons and installation directory of the DSpace
## Create a separate dspace user:
sudo useradd -m dspace
Purpose: Create DSpace system user
Explanation: This command creates a dedicated system user for DSpace operations with a home directory.
Explanation: This command creates a dedicated system user for DSpace operations with a home directory.
## Set a password
sudo passwd dspace
Purpose: Set password for DSpace user
Explanation: This command sets a password for the DSpace user (you'll be prompted to enter and confirm the password).
Explanation: This command sets a password for the DSpace user (you'll be prompted to enter and confirm the password).
## Grant sudo access
sudo usermod -aG sudo dspace
Purpose: Add DSpace user to sudo group
Explanation: This command adds the DSpace user to the sudo group, granting administrative privileges.
Explanation: This command adds the DSpace user to the sudo group, granting administrative privileges.
## Create the DSpace installation directory
sudo mkdir /dspace
Purpose: Create DSpace installation directory
Explanation: This command creates the main directory where DSpace will be installed.
Explanation: This command creates the main directory where DSpace will be installed.
## Changes the ownership of the /dspace directory to the dspace user
sudo chown dspace /dspace
Purpose: Set DSpace directory ownership
Explanation: This command changes ownership of the /dspace directory to the dspace user.
Explanation: This command changes ownership of the /dspace directory to the dspace user.
Step 7: Download and Set Up DSpace Backend (v9.1)
In this step, we'll download the latest DSpace 9.x backend package (currently DSpace 9.1) and prepare it for configuration and build.
## Create a Temporary Build Directory
sudo mkdir /opt/build
Purpose: Create build directory
Explanation: This command creates a temporary directory for building DSpace.
Explanation: This command creates a temporary directory for building DSpace.
## Download the Latest DSpace 9.1 Package
sudo wget https://github.com/DSpace/DSpace/archive/refs/tags/dspace-9.1.tar.gz -P /opt/build/
Purpose: Download DSpace source code
Explanation: This command downloads the DSpace 9.1 source code from GitHub to the build directory.
Explanation: This command downloads the DSpace 9.1 source code from GitHub to the build directory.
## Extract and Organize the Source Code
sudo tar xzf /opt/build/dspace-9.1.tar.gz -C /opt/build/
Purpose: Extract DSpace archive
Explanation: This command extracts the downloaded DSpace source code.
Explanation: This command extracts the downloaded DSpace source code.
## Rename Directory (Cleanup)
sudo mv /opt/build/DSpace-dspace-9.1/ /opt/build/dspace-backend
Purpose: Rename DSpace directory
Explanation: This command renames the extracted directory for easier reference.
Explanation: This command renames the extracted directory for easier reference.
## Remove Downloaded Archive
sudo rm /opt/build/dspace-9.1.tar.gz
Purpose: Clean up downloaded file
Explanation: This command removes the downloaded archive file after extraction.
Explanation: This command removes the downloaded archive file after extraction.
## Change the permission
sudo chmod 777 -R /opt/build
Purpose: Set permissions on build directory
Explanation: This command sets full permissions on the build directory to avoid permission issues during the build process.
Explanation: This command sets full permissions on the build directory to avoid permission issues during the build process.
## Configure DSpace Backend
Navigate to the DSpace config directory:
cd /opt/build/dspace-backend/dspace/config/
Purpose: Change to config directory
Explanation: This command navigates to the DSpace configuration directory.
Explanation: This command navigates to the DSpace configuration directory.
Copy the local.cfg.example to local.cfg:
sudo cp local.cfg.EXAMPLE local.cfg
Purpose: Create local configuration
Explanation: This command creates the local configuration file from the example template.
Explanation: This command creates the local configuration file from the example template.
Edit the file using a nano text editor:
sudo nano local.cfg
Purpose: Edit DSpace configuration
Explanation: This command opens the DSpace configuration file for editing.
Explanation: This command opens the DSpace configuration file for editing.
Update key settings in local.cfg:
Replace localhost with your actual domain or IP address for public access.
# Backend REST server
dspace.server.url = http://localhost:8080/server
Purpose: Set backend URL
Explanation: This configuration sets the URL for the DSpace backend REST API.
Explanation: This configuration sets the URL for the DSpace backend REST API.
# Angular frontend
dspace.ui.url = http://localhost:4000
Purpose: Set frontend URL
Explanation: This configuration sets the URL for the DSpace Angular frontend.
Explanation: This configuration sets the URL for the DSpace Angular frontend.
# Site name
dspace.name = DSpace at My University
Purpose: Set institution name
Explanation: This configuration sets the name of your DSpace repository.
Explanation: This configuration sets the name of your DSpace repository.
# DB credentials
db.username = dspace
Purpose: Set database username
Explanation: This configuration sets the PostgreSQL database username for DSpace.
Explanation: This configuration sets the PostgreSQL database username for DSpace.
db.password = dspace
Purpose: Set database password
Explanation: This configuration sets the PostgreSQL database password for DSpace.
Explanation: This configuration sets the PostgreSQL database password for DSpace.
Default Local Assetstore Setup:
# Uncomment this line by deleting #:
assetstore.dir = ${dspace.dir}/assetstore
Purpose: Set assetstore directory
Explanation: This configuration sets the directory where DSpace will store uploaded files.
Explanation: This configuration sets the directory where DSpace will store uploaded files.
# Enable Solr by Uncomment this line by deleting #:
solr.server = http://localhost:8983/solr
Purpose: Set Solr server URL
Explanation: This configuration sets the URL for the Solr search server.
Explanation: This configuration sets the URL for the Solr search server.
## Set Up Local Assetstore
sudo mkdir -p /dspace/assetstore
Purpose: Create assetstore directory
Explanation: This command creates the directory where DSpace will store uploaded files.
Explanation: This command creates the directory where DSpace will store uploaded files.
sudo chown -R tomcat:tomcat /dspace/assetstore
Purpose: Set assetstore permissions
Explanation: This command sets ownership of the assetstore directory to the Tomcat user.
Explanation: This command sets ownership of the assetstore directory to the Tomcat user.
## Build and Install the DSpace Backend
Switch to Root User:
sudo su
Purpose: Switch to root user
Explanation: This command switches to the root user for the build process.
Explanation: This command switches to the root user for the build process.
Navigate to the Build Directory (DSpace installation source code)
cd /opt/build/dspace-backend/
Purpose: Change to build directory
Explanation: This command navigates to the DSpace source code directory.
Explanation: This command navigates to the DSpace source code directory.
Build the backend using Maven
mvn package
Purpose: Build DSpace with Maven
Explanation: This command compiles the DSpace source code and creates deployment packages using Maven.
Explanation: This command compiles the DSpace source code and creates deployment packages using Maven.
Install Using Ant:
cd dspace/target/dspace-installer
Purpose: Change to installer directory
Explanation: This command navigates to the DSpace installer directory created by Maven.
Explanation: This command navigates to the DSpace installer directory created by Maven.
ant fresh_install
Purpose: Install DSpace with Ant
Explanation: This command installs DSpace to the /dspace directory using Ant.
Explanation: This command installs DSpace to the /dspace directory using Ant.
Exit root.
exit
Purpose: Exit root user
Explanation: This command exits the root user session and returns to the regular user.
Explanation: This command exits the root user session and returns to the regular user.
## Deploy DSpace webapps to Tomcat and Solr
Copy DSpace backend webapps to Tomcat:
sudo cp -R /dspace/webapps/* /var/lib/tomcat10/webapps
Purpose: Deploy DSpace web applications
Explanation: This command copies the DSpace web applications to the Tomcat webapps directory.
Explanation: This command copies the DSpace web applications to the Tomcat webapps directory.
Copy DSpace Solr cores to the Solr data directory:
sudo cp -R /dspace/solr/* /opt/solr/server/solr/
Purpose: Deploy Solr cores
Explanation: This command copies the DSpace Solr search cores to the Solr server directory.
Explanation: This command copies the DSpace Solr search cores to the Solr server directory.
sudo chown -R solr:solr /opt/solr/server/solr
Purpose: Set Solr core permissions
Explanation: This command sets ownership of the Solr cores to the Solr user.
Explanation: This command sets ownership of the Solr cores to the Solr user.
sudo systemctl restart solr
Purpose: Restart Solr
Explanation: This command restarts Solr to load the DSpace cores.
Explanation: This command restarts Solr to load the DSpace cores.
## Initialize the Database
Run the migration to set up schema:
cd /dspace/bin/
Purpose: Change to DSpace bin directory
Explanation: This navigates to the DSpace binary directory where essential administrative commands are available.
Explanation: This navigates to the DSpace binary directory where essential administrative commands are available.
sudo ./dspace database migrate
Purpose: Apply database migrations
Explanation: This command initializes or updates the database schema for DSpace by applying the latest migrations.
Explanation: This command initializes or updates the database schema for DSpace by applying the latest migrations.
## Create DSpace Administrator Account
sudo ./dspace create-administrator
Purpose: Create a DSpace admin user
Explanation: This command starts a prompt to create the initial DSpace administrator, which is required to access the admin panel.
Explanation: This command starts a prompt to create the initial DSpace administrator, which is required to access the admin panel.
## Set Permissions Ownership and Restart Tomcat and Solr
sudo chown -R tomcat:tomcat /dspace/
Purpose: Set ownership of DSpace files
Explanation: This sets proper ownership so that the Tomcat process can access and manage DSpace files without permission errors.
Explanation: This sets proper ownership so that the Tomcat process can access and manage DSpace files without permission errors.
sudo systemctl restart tomcat10
Purpose: Restart Tomcat server
Explanation: Restarts the Tomcat application server to load the deployed DSpace application and reflect recent changes.
Explanation: Restarts the Tomcat application server to load the deployed DSpace application and reflect recent changes.
sudo systemctl restart solr
Purpose: Restart Solr
Explanation: This command restarts Solr to ensure it's running with the DSpace cores.
Explanation: This command restarts Solr to ensure it's running with the DSpace cores.
## Verify Backend Installation.
Once the backend is deployed, you can verify it's running by accessing the following endpoints in your browser.
Note: Replace localhost with your actual server IP or domain name if accessing remotely.
REST API:
http://localhost:8080/server
Purpose: REST API endpoint
Explanation: This is the URL for the DSpace REST API, which should return a response if the backend is running correctly.
Explanation: This is the URL for the DSpace REST API, which should return a response if the backend is running correctly.
OAI-PMH:
http://localhost:8080/server/oai/request?verb=Identify
Purpose: OAI-PMH endpoint
Explanation: This is the URL for the OAI-PMH interface, which should return repository information if configured correctly.
Explanation: This is the URL for the OAI-PMH interface, which should return repository information if configured correctly.
