Difference between revisions of "DSpace/C2/DSpace-Installation-on-Ubuntu-Linux-OS/English"

From Script | Spoken-Tutorial
Jump to: navigation, search
(Created page with "'''Script: Dspace installation on Ubuntu Linux OS''' '''Author : Pankaj Patil''' '''Keywords: DSpace installation, DSpace build, DSpace deployment, DSpace administrator ac...")
 
 
Line 9: Line 9:
  
  
−
{| style="border-spacing:0;width:16.51cm;"
+
{| border =1
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|'''Visual Cue'''
−
| align=center| '''Visual Cue'''
+
|'''Narration'''
−
| align=center| '''Narration'''
+
|-  
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
 
|| Slide : Title
 
|| Slide : Title
 
|| Welcome to this spoken tutorial on installation of '''DSpace''' on''' Ubuntu Linux OS.'''  
 
|| Welcome to this spoken tutorial on installation of '''DSpace''' on''' Ubuntu Linux OS.'''  
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Slide: Learning Objectives Slide
 
|| Slide: Learning Objectives Slide
−
|| In this tutorial, we will learn to * <div style="margin-left:1.27cm;margin-right:0cm;">Install '''DSpace''' on '''Ubuntu Linux OS''' </div>
+
|| In this tutorial, we will learn to  
−
* <div style="margin-left:1.27cm;margin-right:0cm;">Crossverify '''DSpace''' installation and</div>
+
* Install '''DSpace''' on '''Ubuntu Linux OS'''  
−
* <div style="margin-left:1.27cm;margin-right:0cm;">Create a '''DSpace administrator account'''</div>
+
* Crossverify '''DSpace''' installation and
 +
* Create a '''DSpace administrator account'''
  
−
 
+
|-  
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
 
|| Slide: System requirements
 
|| Slide: System requirements
−
|| This tutorial is recorded using* <div style="margin-left:1.27cm;margin-right:0cm;">'''Ubuntu Linux OS 18.04'''</div>
+
|| This tutorial is recorded using
−
* <div style="margin-left:1.27cm;margin-right:0cm;">'''gedit text editor''' and</div>
+
* '''Ubuntu Linux''' OS 18.04
−
* <div style="margin-left:1.27cm;margin-right:0cm;">'''Firefox web browser'''</div>
+
* '''gedit text editor''' and
−
 
+
* '''Firefox web browser'''
−
 
+
−
 
+
−
 
+
  
 
However you may use any other '''editor''' or '''browser''' of your choice.
 
However you may use any other '''editor''' or '''browser''' of your choice.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Slide: Pre-requisites
 
|| Slide: Pre-requisites
−
|| To practice this tutorial, you should have * <div style="margin-left:1.27cm;margin-right:0cm;">installed '''Java, Tomcat 8, Postgresql 10, Ant, Maven, '''and''' git.'''</div>
+
|| To practice this tutorial, you should have  
−
* <div style="margin-left:1.27cm;margin-right:0cm;">configured '''Tomcat 8 server '''and </div>
+
* installed '''Java, Tomcat 8, Postgresql 10, Ant, Maven, '''and''' git.'''
−
* <div style="margin-left:1.27cm;margin-right:0cm;">created a '''dspace database '''in''' Postgresql 10.'''</div>
+
* configured '''Tomcat 8 server '''and  
 +
* created a '''dspace database '''in''' Postgresql 10.'''
  
−
 
+
|-  
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
 
|| Slide: Pre-requisites
 
|| Slide: Pre-requisites
 
|| You will also need minimum 5 unique '''email ids''' for practising various '''roles''' in '''DSpace'''.
 
|| You will also need minimum 5 unique '''email ids''' for practising various '''roles''' in '''DSpace'''.
Line 47: Line 43:
  
 
If you don’t have, then please create them before proceeding ahead.
 
If you don’t have, then please create them before proceeding ahead.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Slide: Pre-requisites
 
|| Slide: Pre-requisites
−
|| Pre-requisites:* <div style="margin-left:1.27cm;margin-right:0cm;">You should have familiarity with basic '''Linux commands'''.</div>
+
|| Pre-requisites:
−
* <div style="margin-left:1.27cm;margin-right:0cm;">If not then please go through the prerequisite '''Linux '''tutorials on this website.</div>
+
* You should have familiarity with basic '''Linux commands'''.
 +
* If not then please go through the prerequisite '''Linux '''tutorials on this website.
  
−
 
+
|-  
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
 
|| Slide : Code files
 
|| Slide : Code files
−
|| * <div style="margin-left:1.27cm;margin-right:0cm;">The '''commands''' used in this tutorial are available in the '''Code Files '''link on this tutorial page.</div>
+
||  
−
 
+
* The '''commands''' used in this tutorial are available in the '''Code Files '''link on this tutorial page.
−
 
+
* Please download and extract the file before practicing.
−
 
+
−
* <div style="margin-left:1.27cm;margin-right:0cm;">Please download and extract the file before practicing.</div>
+
−
 
+
  
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Switch to '''gedit''' text editor and open the file
 
|| Switch to '''gedit''' text editor and open the file
 
|| I have opened the '''code file''' in '''gedit text editor''' on my machine.
 
|| I have opened the '''code file''' in '''gedit text editor''' on my machine.
Line 70: Line 63:
  
  
−
Shortcut to paste on the '''terminal''' is '''Shift, Ctrl '''and '''V '''keys'''.'''
+
Shortcut to paste on the '''terminal''' is '''Shift, Ctrl '''and '''V '''keys.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Narration only
 
|| Narration only
 
|| Let us begin.
 
|| Let us begin.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Press '''Ctrl+Alt+T keys'''
 
|| Press '''Ctrl+Alt+T keys'''
 
|| Open the '''terminal''' by pressing '''Ctrl ,Alt '''and '''T''' keys simultaneously on the keyboard.
 
|| Open the '''terminal''' by pressing '''Ctrl ,Alt '''and '''T''' keys simultaneously on the keyboard.
Line 80: Line 73:
  
 
Ensure that you have '''root permissions''' to run the '''commands'''.
 
Ensure that you have '''root permissions''' to run the '''commands'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Only Narration
 
|| Only Narration
 
|| Here onwards please remember to press the '''Enter''' key after typing each '''command'''.
 
|| Here onwards please remember to press the '''Enter''' key after typing each '''command'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
Line 95: Line 88:
  
 
If prompted, then type the '''admin''' '''password '''to '''login'''.
 
If prompted, then type the '''admin''' '''password '''to '''login'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
Line 103: Line 96:
  
 
If not, type '''cd $HOME''' to switch to the '''Home directory'''.
 
If not, type '''cd $HOME''' to switch to the '''Home directory'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
−
 
  
 
'''wget https://github.com/DSpace/DSpace/releases/download/dspace-6.3/dspace-6.3-src-release.tar.gz'''
 
'''wget https://github.com/DSpace/DSpace/releases/download/dspace-6.3/dspace-6.3-src-release.tar.gz'''
 
|| To download''' DSpace 6.3''' '''source code''', type the '''command''' as shown here.
 
|| To download''' DSpace 6.3''' '''source code''', type the '''command''' as shown here.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
−
 
  
 
'''tar -xzvf $HOME/dspace-6.3-src-release.tar.gz'''
 
'''tar -xzvf $HOME/dspace-6.3-src-release.tar.gz'''
Line 118: Line 109:
  
 
To do so, type the '''command''' as shown here.
 
To do so, type the '''command''' as shown here.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
−
 
  
 
'''ls dspace-6.3-src-release/dspace/config/'''
 
'''ls dspace-6.3-src-release/dspace/config/'''
−
|| To see the contents of the DSpace configure folder.
+
|| To see the contents of the '''DSpace configure''' folder, type this '''command'''.
−
 
+
|-  
−
 
+
−
Type this command.
+
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
 
|| Point to '''local.cfg.EXAMPLE''' in folder view
 
|| Point to '''local.cfg.EXAMPLE''' in folder view
−
 
  
 
'''HOME Directory >> dspace-6.3-src-release >> dspace >> config>>local.cfg.EXAMPLE'''
 
'''HOME Directory >> dspace-6.3-src-release >> dspace >> config>>local.cfg.EXAMPLE'''
 
|| '''DSpace''' source code has '''local.cfg.EXAMPLE, '''which is a sample '''DSpace configuration'''.
 
|| '''DSpace''' source code has '''local.cfg.EXAMPLE, '''which is a sample '''DSpace configuration'''.
−
 
−
 
−
 
  
 
'''DSpace''' checks for the '''configuration''' in the '''local.cfg''' file.
 
'''DSpace''' checks for the '''configuration''' in the '''local.cfg''' file.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Slide : '''local.cfg''' file
 
|| Slide : '''local.cfg''' file
−
|| '''local.cfg''' file can be created in two ways.# <div style="margin-left:1.27cm;margin-right:0cm;">Renaming '''local.cfg.EXAMPLE''' as '''local.cfg'''</div>
+
|| '''local.cfg''' file can be created in two ways.
−
# <div style="margin-left:1.27cm;margin-right:0cm;">Copy '''local.cfg.EXAMPLE''' as '''local.cfg'''</div>
+
# Renaming '''local.cfg.EXAMPLE''' as '''local.cfg'''
−
 
+
# Copy '''local.cfg.EXAMPLE''' as '''local.cfg'''
−
 
+
−
 
+
−
 
+
  
 
Switch to the '''terminal.'''
 
Switch to the '''terminal.'''
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
Line 156: Line 136:
  
 
To do so, type the '''command''' as shown.
 
To do so, type the '''command''' as shown.
−
 
+
|-  
−
 
+
−
 
+
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
Line 173: Line 150:
  
 
'''Configuration file''' opens in the '''text editor'''.
 
'''Configuration file''' opens in the '''text editor'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| '''SERVER CONFIGURATION'''
 
|| '''SERVER CONFIGURATION'''
 
|| Locate the '''SERVER CONFIGURATION '''section.
 
|| Locate the '''SERVER CONFIGURATION '''section.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
||  
 
||  
  
Line 193: Line 170:
  
 
Value for '''dspace.dir''' is''' /home/dspace/dspace-install'''
 
Value for '''dspace.dir''' is''' /home/dspace/dspace-install'''
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| '''dspace.ui = xmlui'''
 
|| '''dspace.ui = xmlui'''
  
Line 209: Line 186:
  
  
−
'''dspace.ui '''is left blank, to enable '''email'''-based user verification.
+
'''dspace.ui '''is left blank, to enable '''email'''-based '''user''' verification.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| '''Highlight'''
 
|| '''Highlight'''
  
Line 224: Line 201:
  
  
−
Then set the machine ip as a value for '''dspace.hostname''', '''dspace.baseUrl '''and '''solr.server.'''
+
Then set the '''machine ip''' as a value for '''dspace.hostname, dspace.baseUrl '''and '''solr.server.'''
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Point to '''DATABASE CONFIGURATION'''
 
|| Point to '''DATABASE CONFIGURATION'''
  
Line 238: Line 215:
  
 
Enter the value for '''db.username''' as '''dspace''' and '''db.password''' as '''dbuserpass'''.
 
Enter the value for '''db.username''' as '''dspace''' and '''db.password''' as '''dbuserpass'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Press '''Ctrl + S '''>> Close File
 
|| Press '''Ctrl + S '''>> Close File
 
|| Save and close the file.
 
|| Save and close the file.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
Line 255: Line 232:
  
 
Type the '''root user password''' if prompted.
 
Type the '''root user password''' if prompted.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
Line 263: Line 240:
  
 
To do so, type the '''command''' as shown here.  
 
To do so, type the '''command''' as shown here.  
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
 
'''cd dspace-6.3-src-release'''
 
'''cd dspace-6.3-src-release'''
 
|| Using '''cd command''' go to the '''directory dspace-6.3-src-release '''in the '''Home folder'''.
 
|| Using '''cd command''' go to the '''directory dspace-6.3-src-release '''in the '''Home folder'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
Line 283: Line 260:
  
 
The download may''' '''take some time depending on your '''internet speed'''.
 
The download may''' '''take some time depending on your '''internet speed'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Highlight:
 
|| [Terminal] Highlight:
  
 
BUILD SUCCESSFUL message
 
BUILD SUCCESSFUL message
 
|| Once the download is complete, '''BUILD SUCCESSFUL''' message will be displayed on the '''terminal'''.
 
|| Once the download is complete, '''BUILD SUCCESSFUL''' message will be displayed on the '''terminal'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Slide: Troubleshoot for build failure
 
|| Slide: Troubleshoot for build failure
−
 
  
  
 
|| In case you get '''BUILD FAILED '''message, do the following-
 
|| In case you get '''BUILD FAILED '''message, do the following-
 +
* Verify all steps executed earlier by referring to the prerequisite tutorial.
 +
* Also check the version of all the '''packages '''installed.
  
−
 
+
|-  
−
* <div style="margin-left:1.27cm;margin-right:0cm;">Verify all steps executed earlier by referring to the prerequisite tutorial.</div>
+
−
* <div style="margin-left:1.27cm;margin-right:0cm;">Also check the version of all the '''packages '''installed.</div>
+
−
 
+
−
 
+
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
 
'''cd dspace/target/dspace-installer'''
 
'''cd dspace/target/dspace-installer'''
 
|| Now, using the '''cd command,''' go to the '''directory dspace-installer.'''
 
|| Now, using the '''cd command,''' go to the '''directory dspace-installer.'''
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
Line 314: Line 287:
  
 
To install '''DSpace''' using '''ant''', type the '''command''' as shown.
 
To install '''DSpace''' using '''ant''', type the '''command''' as shown.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Highlight:
 
|| [Terminal] Highlight:
  
 
BUILD SUCCESSFUL message
 
BUILD SUCCESSFUL message
 
|| Once the installation is complete, '''BUILD SUCCESSFUL''' message will be displayed on the '''terminal'''.
 
|| Once the installation is complete, '''BUILD SUCCESSFUL''' message will be displayed on the '''terminal'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
−
 
  
 
'''sudo $HOME/dspace-install/bin/dspace create-administrator'''
 
'''sudo $HOME/dspace-install/bin/dspace create-administrator'''
Line 331: Line 303:
  
 
If prompted, type the '''admin user password.'''
 
If prompted, type the '''admin user password.'''
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Email: [mailto:dspace.u1@gmail.com dspace.u1@gmail.com]
 
|| Email: [mailto:dspace.u1@gmail.com dspace.u1@gmail.com]
−
 
  
 
First name : User1
 
First name : User1
Line 340: Line 311:
  
 
These are mandatory '''fields'''.
 
These are mandatory '''fields'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Last name :  
 
|| Last name :  
 
|| I’m skipping the '''Last name '''field.
 
|| I’m skipping the '''Last name '''field.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Password : u1pass
 
|| Password : u1pass
 
|| Now set the '''password''' for the '''dspace admin account.'''
 
|| Now set the '''password''' for the '''dspace admin account.'''
Line 349: Line 320:
  
 
I will type '''u1pass''' and press '''Enter'''.
 
I will type '''u1pass''' and press '''Enter'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Retype the admin password
 
|| Retype the admin password
  
 
Password: u1pass
 
Password: u1pass
 
|| Type the '''password '''once again and press '''Enter.'''
 
|| Type the '''password '''once again and press '''Enter.'''
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Type '''Y''' to confirm entered details.
 
|| Type '''Y''' to confirm entered details.
 
|| The '''prompt''' will ask you to type '''Y''' to confirm the newly added details.
 
|| The '''prompt''' will ask you to type '''Y''' to confirm the newly added details.
Line 360: Line 331:
  
 
Type '''Y''' and press '''Enter'''.
 
Type '''Y''' and press '''Enter'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Only narration
 
|| Only narration
−
|| '''Administrator’s credentials''' are used to '''login''' to '''DSpace''' portal with '''Administrator '''authority'''.'''
+
|| '''Administrator’s credentials''' are used to '''login''' to '''DSpace''' portal with '''Administrator '''authority.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Narration only
 
|| Narration only
−
|| Now, let us proceed to deploy '''dspace webapps '''on''' tomcat.'''
+
|| Now, let us proceed to deploy '''DSpace Webapps '''on''' Tomcat.'''
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
 
'''cd /var/lib/tomcat8/webapps/'''
 
'''cd /var/lib/tomcat8/webapps/'''
 
|| Type the '''command''' as shown to navigate to '''tomcat webapps.'''
 
|| Type the '''command''' as shown to navigate to '''tomcat webapps.'''
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type: '''ls'''
 
|| [Terminal] Type: '''ls'''
 
|| Type''' ls '''to see the folder contents.
 
|| Type''' ls '''to see the folder contents.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Point to '''ROOT '''directory''' '''
 
|| Point to '''ROOT '''directory''' '''
 
|| '''ROOT '''is the default''' webapp '''created during '''tomcat '''installation.''' '''
 
|| '''ROOT '''is the default''' webapp '''created during '''tomcat '''installation.''' '''
  
 
'''Tomcat server''' redirects client requests to default '''ROOT''' '''webapp'''.
 
'''Tomcat server''' redirects client requests to default '''ROOT''' '''webapp'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
Line 387: Line 358:
  
  
−
Therefore, we will '''delete''' the default '''ROOT webapp''' on '''tomcat''' '''server.'''
+
Therefore, we will '''delete''' the default '''ROOT webapp''' on '''Tomcat server.'''
  
  
Line 394: Line 365:
  
 
If prompted, enter the '''root user password'''.  
 
If prompted, enter the '''root user password'''.  
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Narration only
 
|| Narration only
−
|| Now, we will deploy '''DSpace webapps''' on '''tomcat.'''
+
|| Now, we will deploy '''DSpace webapps''' on '''Tomcat.'''
  
  
 
'''DSpace''' offers '''JSP''' and '''XML''' based '''user interfaces'''.  
 
'''DSpace''' offers '''JSP''' and '''XML''' based '''user interfaces'''.  
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
Line 409: Line 380:
  
 
To do so, type the '''command''' as shown.
 
To do so, type the '''command''' as shown.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| '''sudo ln -s /home/dspace/dspace-install/webapps/rest'''
 
|| '''sudo ln -s /home/dspace/dspace-install/webapps/rest'''
 
|| Next we’ll deploy '''rest webapp,''' by typing the '''command''' as shown.
 
|| Next we’ll deploy '''rest webapp,''' by typing the '''command''' as shown.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| '''sudo ln -s /home/dspace/dspace-install/webapps/solr'''
 
|| '''sudo ln -s /home/dspace/dspace-install/webapps/solr'''
 
|| Now, we will deploy '''solr webapp,''' by typing this command.
 
|| Now, we will deploy '''solr webapp,''' by typing this command.
  
−
 
+
|-  
−
 
+
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
 
|| '''sudo ln -s /home/dspace/dspace-install/webapps/oai'''
 
|| '''sudo ln -s /home/dspace/dspace-install/webapps/oai'''
 
|| And then to deploy '''oai webapp,''' type the command as shown.
 
|| And then to deploy '''oai webapp,''' type the command as shown.
  
−
 
+
|-  
−
 
+
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
 
|| '''sudo ln -s /home/dspace/dspace-install/webapps/sword'''
 
|| '''sudo ln -s /home/dspace/dspace-install/webapps/sword'''
 
|| Lastly, we’ll deploy '''sword webapp,''' by typing this command.
 
|| Lastly, we’ll deploy '''sword webapp,''' by typing this command.
  
−
 
+
|-  
−
 
+
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
  
 
'''sudo service tomcat8 restart'''
 
'''sudo service tomcat8 restart'''
−
|| Restart '''tomcat''' '''server '''by typing the following command.
+
|| Restart '''Tomcat server '''by typing the following '''command'''.
  
  
−
If '''tomcat''' is not restarted''', '''then deployed '''applications''' will not be effective to handle '''client requests.'''
+
If '''Tomcat''' is not restarted, then deployed '''applications''' will not be effective to handle '''client requests.'''
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| [Terminal] Type:
 
|| [Terminal] Type:
  
Line 451: Line 416:
  
 
Our system will get restarted.
 
Our system will get restarted.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Narration only
 
|| Narration only
 
|| We have now successfully installed '''DSpace.'''
 
|| We have now successfully installed '''DSpace.'''
Line 457: Line 422:
  
 
Next, proceed to access '''DSpace''' through the '''browser.'''
 
Next, proceed to access '''DSpace''' through the '''browser.'''
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| '''Browser >>'''
 
|| '''Browser >>'''
  
Line 473: Line 438:
  
  
−
'''DSpace''' '''home''' page appears on the '''browser'''.
+
'''DSpace Home page''' appears on the '''browser'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Narration only
 
|| Narration only
 
|| Now, we will '''login''' to '''DSpace''' with our '''administrator account'''.
 
|| Now, we will '''login''' to '''DSpace''' with our '''administrator account'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Click''' Sign on to tab > My DSpace'''
 
|| Click''' Sign on to tab > My DSpace'''
 
|| Click on '''Sign on to '''tab at the top right corner.
 
|| Click on '''Sign on to '''tab at the top right corner.
Line 485: Line 450:
  
  
−
'''Log In to''' '''DSpace''' form opens.
+
'''Log In to DSpace''' form opens.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Enter Email Address and Password
 
|| Enter Email Address and Password
  
Line 494: Line 459:
 
Password: u1pass
 
Password: u1pass
 
|| Type in the '''email address''' and '''password''' of the '''administrator'''.
 
|| Type in the '''email address''' and '''password''' of the '''administrator'''.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Click on''' Log In '''button
 
|| Click on''' Log In '''button
 
|| Then click on the '''Log In''' button below the '''password''' field.
 
|| Then click on the '''Log In''' button below the '''password''' field.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Point to '''My DSpace '''section
 
|| Point to '''My DSpace '''section
 
|| The '''administrator login''' is successful and '''My DSpace''' page appears.
 
|| The '''administrator login''' is successful and '''My DSpace''' page appears.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Narration only
 
|| Narration only
 
|| This brings us to the end of this tutorial.
 
|| This brings us to the end of this tutorial.
Line 506: Line 471:
  
 
Let us summarize.
 
Let us summarize.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Slide : Summary
 
|| Slide : Summary
  
  
  
−
|| In this tutorial we learnt to-* <div style="margin-left:1.27cm;margin-right:0cm;">Install '''DSpace''' on''' Ubuntu Linux OS '''</div>
+
|| In this tutorial we learnt to-
−
* <div style="margin-left:1.27cm;margin-right:0cm;">Crossverify the '''DSpace''' installation and</div>
+
* Install '''DSpace''' on''' Ubuntu Linux OS '''
−
* <div style="margin-left:1.27cm;margin-right:0cm;">Create a '''DSpace administrator account'''</div>
+
* Crossverify the '''DSpace''' installation and
−
 
+
* Create a '''DSpace administrator account'''
−
 
+
|-  
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
 
|| Slide : About Spoken Tutorial project
 
|| Slide : About Spoken Tutorial project
 
|| The video at the following link summarises the '''Spoken Tutorial project.'''
 
|| The video at the following link summarises the '''Spoken Tutorial project.'''
Line 522: Line 486:
  
 
Please download and watch it.
 
Please download and watch it.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Slide : Spoken Tutorial workshops
 
|| Slide : Spoken Tutorial workshops
  
Line 534: Line 498:
 
|| Slide: Answers for THIS Spoken Tutorial
 
|| Slide: Answers for THIS Spoken Tutorial
 
|| Please post your timed queries in this Forum.
 
|| Please post your timed queries in this Forum.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Slide: Acknowledgement -I
 
|| Slide: Acknowledgement -I
 
|| '''Spoken Tutorial project''' is funded by MHRD, Government of India.
 
|| '''Spoken Tutorial project''' is funded by MHRD, Government of India.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Slide: Acknowledgement -II
 
|| Slide: Acknowledgement -II
  
Line 543: Line 507:
  
 
|| '''DSpace spoken tutorial''' series is funded by the National Virtual Library of India, Ministry of Culture, Government of India.
 
|| '''DSpace spoken tutorial''' series is funded by the National Virtual Library of India, Ministry of Culture, Government of India.
−
|- style="border:1pt solid #000000;padding:0.176cm;"
+
|-  
 
|| Narration only
 
|| Narration only
  

Latest revision as of 19:33, 29 May 2020

Script: Dspace installation on Ubuntu Linux OS


Author : Pankaj Patil


Keywords: DSpace installation, DSpace build, DSpace deployment, DSpace administrator account, local.cfg configuration


Visual Cue Narration
Slide : Title Welcome to this spoken tutorial on installation of DSpace on Ubuntu Linux OS.
Slide: Learning Objectives Slide In this tutorial, we will learn to
  • Install DSpace on Ubuntu Linux OS
  • Crossverify DSpace installation and
  • Create a DSpace administrator account
Slide: System requirements This tutorial is recorded using
  • Ubuntu Linux OS 18.04
  • gedit text editor and
  • Firefox web browser

However you may use any other editor or browser of your choice.

Slide: Pre-requisites To practice this tutorial, you should have
  • installed Java, Tomcat 8, Postgresql 10, Ant, Maven, and git.
  • configured Tomcat 8 server and
  • created a dspace database in Postgresql 10.
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: Pre-requisites Pre-requisites:
  • You should have familiarity with basic Linux commands.
  • If not then please go through the prerequisite Linux tutorials on this website.
Slide : Code files
  • The commands used in this tutorial are available in the Code Files link on this tutorial page.
  • Please download and extract the file before practicing.
Switch to gedit text editor and open the file I have opened the code file in gedit text editor on my machine.


And I will use the same file to copy-paste the commands during the demonstration.


Shortcut to paste on the terminal is Shift, Ctrl and V keys.

Narration only Let us begin.
Press Ctrl+Alt+T keys Open the terminal by pressing Ctrl ,Alt and T keys simultaneously on the keyboard.


Ensure that you have root permissions to run the commands.

Only Narration Here onwards please remember to press the Enter key after typing each command.
[Terminal] Type:


sudo su - dspace

Now, we will login as user dspace.


Type sudo su - dspace


If prompted, then type the admin password to login.

[Terminal] Type:

cd $HOME

Make sure that your present working directory in the terminal is DSpace’s Home directory.


If not, type cd $HOME to switch to the Home directory.

[Terminal] Type:

wget https://github.com/DSpace/DSpace/releases/download/dspace-6.3/dspace-6.3-src-release.tar.gz

To download DSpace 6.3 source code, type the command as shown here.
[Terminal] Type:

tar -xzvf $HOME/dspace-6.3-src-release.tar.gz

Now let us extract the DSpace tar file which we downloaded.


To do so, type the command as shown here.

[Terminal] Type:

ls dspace-6.3-src-release/dspace/config/

To see the contents of the DSpace configure folder, type this command.
Point to local.cfg.EXAMPLE in folder view

HOME Directory >> 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.
  1. Renaming local.cfg.EXAMPLE as local.cfg
  2. Copy local.cfg.EXAMPLE as local.cfg

Switch to the terminal.

[Terminal] Type:

cp $HOME/dspace-6.3-src-release/dspace/config/local.cfg.EXAMPLE $HOME/dspace-6.3-src-release/dspace/config/local.cfg

We’ll create a copy of local.cfg.EXAMPLE file as local.cfg for DSpace configuration.


To do so, type the command as shown.

[Terminal] Type:

sudo gedit /home/dspace/dspace-6.3-src-release/dspace/config/local.cfg

Open the local.cfg file by typing the following command.


If prompted, type the dspace user password.


You may open this file in any text editor of your choice.


Configuration file opens in the text editor.

SERVER CONFIGURATION Locate the SERVER CONFIGURATION section.

dspace.dir=/home/dspace/dspace-install


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 /home/dspace/dspace-install

dspace.ui = xmlui



dspace.ui =


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

Suppose if 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.
[Terminal] Type:

sudo chown dspace.dspace -R $HOME


Now, let us provide ownership of the Home directory to the dspace user.


To do so, type the command as shown here.


Type the root user password if prompted.

[Terminal] Type:

sudo chmod 0777 -R $HOME

Next, let us provide the read, write and execute permissions to the Home directory of dspace user.


To do so, type the command as shown here.

[Terminal] Type:

cd dspace-6.3-src-release

Using cd command go to the directory dspace-6.3-src-release in the Home folder.
[Terminal] 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.

[Terminal] Highlight:

BUILD SUCCESSFUL message

Once the download is complete, BUILD SUCCESSFUL message will be displayed on the terminal.
Slide: Troubleshoot for build failure


In case you get BUILD FAILED message, do the following-
  • Verify all steps executed earlier by referring to the prerequisite tutorial.
  • Also check the version of all the packages installed.
[Terminal] Type:

cd dspace/target/dspace-installer

Now, using the cd command, go to the directory dspace-installer.
[Terminal] Type:


ant fresh_install

Apache Ant is a tool used to build DSpace binaries.


To install DSpace using ant, type the command as shown.

[Terminal] Highlight:

BUILD SUCCESSFUL message

Once the installation is complete, BUILD SUCCESSFUL message will be displayed on the terminal.
[Terminal] Type:

sudo $HOME/dspace-install/bin/dspace create-administrator

Next, we will create a DSpace administrator account and set the credentials.


To do so, type the command as shown here.


If prompted, type the admin user password.

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 you to type Y to confirm the newly added details.


Type Y and press Enter.

Only narration Administrator’s credentials are used to login to DSpace portal with Administrator authority.
Narration only Now, let us proceed to deploy DSpace Webapps on Tomcat.
[Terminal] Type:

cd /var/lib/tomcat8/webapps/

Type the command as shown to navigate to tomcat webapps.
[Terminal] Type: ls Type ls 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.

[Terminal] Type:


sudo rm -rf ROOT

For DSpace, we need to set up JSPUI as a ROOT web app.


Therefore, we will delete the default ROOT webapp on Tomcat server.


To do so, type the command as shown.


If prompted, enter the root user password.

Narration only Now, we will deploy DSpace webapps on Tomcat.


DSpace offers JSP and XML based user interfaces.

[Terminal] Type:


sudo ln -s /home/dspace/dspace-install/webapps/jspui ROOT

We will deploy DSpace with JSPUI interface as a default.


To do so, type the command as shown.

sudo ln -s /home/dspace/dspace-install/webapps/rest Next we’ll deploy rest webapp, by typing the command as shown.
sudo ln -s /home/dspace/dspace-install/webapps/solr Now, we will deploy solr webapp, by typing this command.
sudo ln -s /home/dspace/dspace-install/webapps/oai And then to deploy oai webapp, type the command as shown.
sudo ln -s /home/dspace/dspace-install/webapps/sword Lastly, we’ll deploy sword webapp, by typing this command.
[Terminal] Type:


sudo service tomcat8 restart

Restart Tomcat server by typing the following command.


If Tomcat is not restarted, then deployed applications will not be effective to handle client requests.

[Terminal] Type:


sudo reboot

Finally, restart the system before accessing DSpace.


To do so, type sudo reboot in the terminal.


Our system will get restarted.

Narration only We have now successfully installed DSpace.


Next, proceed to access DSpace through the browser.

Browser >>

http://localhost:8080

Open a web browser.


Type http://localhost:8080 in the address bar.


If you have set any ip address in the configuration, then type that ip instead of localhost.


Then press Enter.


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.


Log In to DSpace form 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 This brings us to the end of this tutorial.


Let us summarize.

Slide : Summary


In this tutorial we learnt to-
  • Install DSpace on Ubuntu Linux OS
  • Crossverify the DSpace installation and
  • Create a DSpace administrator account
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 MHRD, 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.

Contributors and Content Editors

Nancyvarkey, Pankajpatil694

Retrieved from "https://script.spoken-tutorial.org/index.php?title=DSpace/C2/DSpace-Installation-on-Ubuntu-Linux-OS/English&oldid=52322"