DSpace/C2/DSpace-Installation-on-Windows-OS/English
Script: Dspace installation on Windows 10 OS
Author : Pankaj Patil
Keywords: DSpace installation, DSpace build, DSpace deployment, DSpace administrator account, local.cfg configuration, Dspace on Windows 10 OS
| Visual Cue | Narration |
| Slide : Title | Welcome to this spoken tutorial on Dspace Installation on Windows 10 OS. |
| Slide: Learning Objectives Slide | In this tutorial, we will learn to
|
| Slide: System requirements | This tutorial is recorded using
However you may use any other editor or browser of your choice. |
| Slide: Pre-requisites | To practice this tutorial, you should have
|
| Slide: Pre-requisites |
|
| Slide: Pre-requisites | You will also need minimum 5 unique email ids for practising various roles in DSpace.
If you don’t have, then please create them before proceeding ahead. |
| Slide : Code files |
|
| Switch to WordPad and open the file | I have opened the commands file in WordPad editor on my machine.
And I will use the same file to copy-paste the commands during the demonstration. The shortcut to paste on the Command Prompt is Ctrl and V keys. |
| Narration only | Let us begin.
First, we will download the source code for DSpace 6.3. |
| Open a web browser. | Open a web browser. |
| [Browser] Type:
https://github.com/DSpace/DSpace/releases/download/dspace-6.3/dspace-6.3-src-release.zip |
In the address bar type the URL as shown and press Enter. |
| Click on the Save file | If prompted, click on the Save file option and then on the OK button. |
| Open Downloads folder | Go to the place where you have downloaded the file on your machine.
In my case it is in the Downloads folder. |
| Copy dspace-6.3-src-release.zip file to C drive | Copy the dspace-6.3-src-release.zip file to C drive. |
| Click Continue | When prompted, click on Continue to provide administrator permissions for copy. |
| Unzip dspace-6.3-src-release.zip file | Now unzip dspace-6.3-src-release.zip file using 7-zip as shown. |
| Point to folder dspace-6.3-src-release | The contents of the zip file are extracted into dspace-6.3-src-release folder. |
| Browse and Point to local.cfg.EXAMPLE in folder view
C Drive >> dspace-6.3-src-release >> dspace >> config>>local.cfg.EXAMPLE |
DSpace source code has local.cfg.EXAMPLE, which is a sample DSpace configuration.
DSpace checks for the configuration in the local.cfg file. |
| Slide : local.cfg file | local.cfg file can be created in two ways:
|
| Create copy of local.cfg.EXAMPLE as local.cfg - Copy.EXAMPLE | First we’ll make a copy of local.cfg.EXAMPLE file by pressing Ctrl + C and then Ctrl + V as shown. |
| Rename local.cfg - Copy.EXAMPLE file as local.cfg. | Then rename the local.cfg - Copy.EXAMPLE file as local.cfg. |
| Click Yes button | Click on the Yes button to confirm the renaming. |
| Open local.cfg file with WordPad | Now open the local.cfg file with WordPad editor. |
| SERVER CONFIGURATION | Locate the SERVER CONFIGURATION section. |
| Enter the path of installation directory
dspace.dir=C:/dspace |
Here, I have set the values for some parameters.
Kindly update in your configuration file also. Webapps created during dspace installation will be stored in dspace.dir path. Value for dspace.dir is C:/dspace |
| dspace.ui = xmlui
dspace.ui = |
The default value of dspace.ui is xmlui.
We will remove that value and leave it as blank. dspace.ui is left blank to enable email-based user verification. |
| Highlight
dspace.hostname = localhost dspace.baseUrl = http://localhost:8080 solr.server = http://localhost:8080/solr |
Now suppose we are working on a remote machine.
Then set the machine ip as a value for dspace.hostname, dspace.baseUrl and solr.server. |
| Point to DATABASE CONFIGURATION
db.username = dspace db.password = dbuserpass |
Locate DATABASE CONFIGURATION section.
Enter the value for db.username as dspace and db.password as dbuserpass. |
| Press Ctrl + S >> Close File | Save and close the file. |
| Type cmd in search box of taskbar | Now go to the search bar located at the bottom left of the taskbar.
Then type cmd. |
| Click on Command Prompt | Click on the Command Prompt application. |
| Only Narration | Here onwards please remember to press the Enter key after typing each command. |
| [Command Prompt] Type:
cd C:\dspace-6.3-src-release |
Using cd command go to the directory dspace-6.3-src-release in the C drive. |
| [Command Prompt] Type:
mvn -U clean package |
Maven package is used to download external Java libraries and build the source code.
To build DSpace, type the command as shown here. The download may take some time depending on your internet speed. |
| [Command Prompt] Highlight:
BUILD SUCCESS message |
Once the download is complete, BUILD SUCCESS message will be displayed on the command prompt. |
| Slide: Troubleshoot for build failure | In case you get BUILD FAILED message, do the following-
|
| [Command Prompt] Type:
cd C:\dspace-6.3-src-release\dspace\target\dspace-installer |
Now, using the cd command go to the directory dspace-installer. |
| [Command Prompt] Type:
ant fresh_install |
Apache Ant is a tool used to build DSpace binaries.
To install DSpace using Ant, type the command as shown. |
| [Command Prompt] Highlight:
BUILD SUCCESSFUL message |
Once the installation is complete, BUILD SUCCESSFUL message will be displayed on the command prompt. |
| Narration Only | Next, we will create a DSpace administrator account and set the credentials. |
| [Command Prompt] Type:
cd C:\dspace\bin |
Using cd command change the present working directory to dspace bin directory. |
| [Command Prompt] Type:
dspace create-administrator |
Type the command as shown to create a DSpace administrator. |
| Email: dspace.u1@gmail.com
First name : User1 |
Type the values for email address and First name as shown.
These are mandatory fields. |
| Last name : | I’m skipping the Last name field. |
| Password : u1pass | Now set the password for the dspace admin account.
I will type u1pass and press Enter. |
| Retype the admin password
Password: u1pass |
Type the password once again and press Enter. |
| Type Y to confirm entered details. | The prompt will ask us to type Y to confirm the newly added details.
Type Y and press Enter. |
| Only narration | Administrator’s credentials are used to login to the DSpace portal with Administrator authority. |
| Close the Command Prompt | Close the command prompt. |
| Narration only | Now, let us proceed to deploy dspace webapps on Tomcat. |
| Narration only | Administrative privileges are required to deploy webapps.
Therefore, let us open the command prompt with Administrative privileges. |
| Type cmd in search box of taskbar | Go to the search bar located at the bottom left of the taskbar.
Then type cmd. |
| Right Click on Command Prompt -> Run as administrator | From the displayed list, right-click on Command Prompt application and select Run as administrator. |
| Click on yes | If prompted, click on the Yes button in the User Account Control dialog box. |
| Point to Administrator:Command Prompt | Command Prompt opens with the administrator privileges. |
| [Command Prompt] Type:
cd C:\Program Files\Apache Software Foundation\Tomcat 8.5\webapps |
Type the command as shown to navigate to Tomcat webapps. |
| [Command Prompt] Type: dir | Type dir to see the folder contents. |
| Point to ROOT directory | ROOT is the default webapp created during Tomcat installation.
Tomcat server redirects client requests to default ROOT webapp. |
| [Command Prompt] Type:
rename ROOT DEFAULT_ROOT |
For DSpace, we need to set up JSPUI as a ROOT web app.
Therefore, we will rename the ROOT as DEFAULT_ROOT. To do so, type the command as shown. |
| Narration only | Now, we will deploy DSpace webapps on Tomcat.
DSpace offers JSP and XML based user interfaces. |
| [Command Prompt] Type:
mklink /D ROOT C:\dspace\webapps\jspui |
We will deploy DSpace with the JSPUI interface as default.
To do so, type the command as shown. |
| mklink /D rest C:\dspace\webapps\rest | Next we’ll deploy rest webapp, by typing the command as shown. |
| mklink /D solr C:\dspace\webapps\solr | Now, we will deploy solr webapp, by typing this command. |
| mklink /D oai C:\dspace\webapps\oai | Next, to deploy oai webapp, type the command as shown. |
| mklink /D sword C:\dspace\webapps\sword | Lastly, we’ll deploy sword webapp, by typing this command. |
| Narration Only | Now, let us restart Tomcat server. |
| [Command Prompt] Type:
cd C:\Program Files\Apache Software Foundation\Tomcat 8.5\bin |
Using cd command change present working directory to Tomcat bin. |
| [Command Prompt] Type:
Tomcat8.exe stop |
To stop the Tomcat server type the command as shown. |
| [Command Prompt] Type:
Tomcat8.exe start |
To start the Tomcat server type the command as shown. |
| Narration only | If tomcat is not restarted, then the deployed applications will not be effective to handle client requests. |
| Restart the System | Finally, restart the system before accessing DSpace. |
| Narration only | We have now successfully installed DSpace.
Next, let us proceed to access DSpace through the web browser. |
| Browser >> | Open a web browser.
Typehttp://localhost:8080 in the address bar. If you have set any ip address in the configuration, then type that ip instead of localhost. And press Enter. The DSpace home page appears on the browser. |
| Narration only | Now, we will login to DSpace with our administrator account. |
| Click Sign on to tab > My DSpace | Click on Sign on to tab at the top right corner.
Select My DSpace from the drop-down. The form Log In to DSpace opens. |
| Enter Email Address and Password
Email: dspace.u1@gmail.com Password: u1pass |
Type in the email address and password of the administrator. |
| Click on Log In button | Then click on the Log In button below the password field. |
| Point to My DSpace section | The administrator login is successful and My DSpace page appears. |
| Narration only | Now, let us log out this user from DSpace. |
| Click on Logged in tab in the top right corner | Click on the Logged in tab at the top right corner. |
| Select Logout from drop down | Select Logout from the drop-down. |
| Point to Logged out message | The user has been logged out. |
| Narration only | This brings us to the end of this tutorial.
Let us summarize. |
| Slide : Summary | In this tutorial, we learnt to-
|
| Slide : About Spoken Tutorial project | The video at the following link summarises the Spoken Tutorial project.
Please download and watch it. |
| Slide : Spoken Tutorial workshops | The Spoken Tutorial Project team conducts workshops and gives certificates.
For more details, please write to us. |
| Slide: Answers for THIS Spoken Tutorial | Please post your timed queries in this Forum. |
| Slide: Acknowledgement -I | Spoken Tutorial project is funded by Ministry of Education (MoE), Government of India. |
| Slide: Acknowledgement -II | DSpace spoken tutorial series is funded by the National Virtual Library of India, Ministry of Culture, Government of India. |
| Narration only | This script and video for this tutorial was contributed by Pankaj Patil from IIT Bombay.
And this is Nancy Varkey signing off. Thanks for joining. |
