Difference between revisions of "DSpace/C2/Email-configuration-for-DSpace-on-Ubuntu-Linux-OS/English"

From Script | Spoken-Tutorial
Jump to: navigation, search
Line 54: Line 54:
 
|| 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 the '''gedit text editor''' on my machine.
 
|| I have opened the '''code file''' in the '''gedit text editor''' on my machine.
−
 
  
 
And I will use the same file to copy-paste the '''commands''' during the demonstration.
 
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'''.'''
 
Shortcut to paste on the '''terminal''' is '''Shift, Ctrl '''and '''V '''keys'''.'''
Line 69: Line 67:
 
*Getting '''Dspace user’s feedback '''and
 
*Getting '''Dspace user’s feedback '''and
 
*Notifications to '''Community and Collection''' subscribers
 
*Notifications to '''Community and Collection''' subscribers
−
 
−
 
 
|-  
 
|-  
 
|| Only Narration
 
|| Only Narration
Line 77: Line 73:
 
|| 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.
−
 
  
 
Ensure that you have '''root permissions''' to '''run''' the '''commands'''.
 
Ensure that you have '''root permissions''' to '''run''' the '''commands'''.
Line 85: Line 80:
 
|-  
 
|-  
 
|| [Terminal] type:  
 
|| [Terminal] type:  
−
 
  
 
'''sudo su - dspace'''
 
'''sudo su - dspace'''
 
|| Now, we will '''login''' as '''user dspace'''.
 
|| Now, we will '''login''' as '''user dspace'''.
−
 
  
 
Type '''sudo su - dspace'''
 
Type '''sudo su - dspace'''
−
 
  
 
If prompted, then type the '''password '''of the''' admin user '''to '''login'''.
 
If prompted, then type the '''password '''of the''' admin user '''to '''login'''.
 
|-  
 
|-  
 
|| [Terminal] type:  
 
|| [Terminal] type:  
−
 
  
 
'''sudo gedit /home/dspace/dspace-6.3-src-release/dspace/config/dspace.cfg'''
 
'''sudo gedit /home/dspace/dspace-6.3-src-release/dspace/config/dspace.cfg'''
 
|| Type the '''command''' as shown to open '''dspace configuration '''file.
 
|| Type the '''command''' as shown to open '''dspace configuration '''file.
−
 
  
 
If prompted, type the '''root user password'''.
 
If prompted, type the '''root user password'''.
−
 
  
 
'''dspace.cfg '''file opens in the '''gedit text editor'''.  
 
'''dspace.cfg '''file opens in the '''gedit text editor'''.  
Line 113: Line 102:
 
|| Slide:''' SMTP Services'''
 
|| Slide:''' SMTP Services'''
 
|| '''DSpace '''requires '''SMTP service''' to send and receive '''emails.'''
 
|| '''DSpace '''requires '''SMTP service''' to send and receive '''emails.'''
−
 
  
 
'''SMTP''' services like '''Gmail, SendinBlue, SendGrid, Pepipost, Amazon SES '''or '''Mandrill''' can be used.
 
'''SMTP''' services like '''Gmail, SendinBlue, SendGrid, Pepipost, Amazon SES '''or '''Mandrill''' can be used.
−
 
  
 
Additionally, custom '''SMTP''' services can also be set up and used.
 
Additionally, custom '''SMTP''' services can also be set up and used.
 
|-  
 
|-  
 
|| '''mail.server = smtp.gmail.com'''
 
|| '''mail.server = smtp.gmail.com'''
−
 
−
 
  
 
|| In this demonstration, I will configure a '''Gmail SMTP mail server.'''
 
|| In this demonstration, I will configure a '''Gmail SMTP mail server.'''
−
 
  
 
So, first I’ll set the value for '''mail.server''' as '''smtp.gmail.com'''
 
So, first I’ll set the value for '''mail.server''' as '''smtp.gmail.com'''
Line 133: Line 117:
 
'''mail.server.password =d$pace2019*'''
 
'''mail.server.password =d$pace2019*'''
 
|| Next we have to enter a valid '''gmail ID''' for '''mail.server.username.'''
 
|| Next we have to enter a valid '''gmail ID''' for '''mail.server.username.'''
−
 
  
 
I will use the '''admin’s mail id''', which is [mailto:dspace.u1@gmail.com dspace.u1@gmail.com]
 
I will use the '''admin’s mail id''', which is [mailto:dspace.u1@gmail.com dspace.u1@gmail.com]
−
 
  
 
You can also use the same '''email id''' which you gave as your '''admin mail id'''.
 
You can also use the same '''email id''' which you gave as your '''admin mail id'''.
−
 
  
 
The value for '''mail.server.password '''has to be the '''password''' of [mailto:dspace.u1@gmail.com dspace.u1@gmail.com].'''
 
The value for '''mail.server.password '''has to be the '''password''' of [mailto:dspace.u1@gmail.com dspace.u1@gmail.com].'''
−
 
  
 
The typed '''password''' will be visible to everyone.
 
The typed '''password''' will be visible to everyone.
−
 
  
 
So I have blurred it for this demonstration.
 
So I have blurred it for this demonstration.
Line 153: Line 132:
 
'''mail.server.port'''
 
'''mail.server.port'''
 
|| We will use''' gmail’s SMTP port (SSL): 465''', to connect to the '''SMTP server'''.
 
|| We will use''' gmail’s SMTP port (SSL): 465''', to connect to the '''SMTP server'''.
−
 
  
 
So, let us disable the default '''SMTP port''' which is 25.
 
So, let us disable the default '''SMTP port''' which is 25.
−
 
  
 
To do so, type '''<nowiki># </nowiki>'''in front of the line '''mail.server.port'''.  
 
To do so, type '''<nowiki># </nowiki>'''in front of the line '''mail.server.port'''.  
Line 162: Line 139:
 
|| From Address for mail
 
|| From Address for mail
 
|| Now, give a valid '''email address''' for '''mail.from.address.'''
 
|| Now, give a valid '''email address''' for '''mail.from.address.'''
−
 
  
 
This '''email id''' will be considered as the '''from address''' for the recipients.
 
This '''email id''' will be considered as the '''from address''' for the recipients.
−
 
  
 
Here I will type the value as '''dspace.u1@gmail.com'''
 
Here I will type the value as '''dspace.u1@gmail.com'''
Line 171: Line 146:
 
|| Feedback recipient email
 
|| Feedback recipient email
 
|| Please type a valid''' email address''' for '''feedback.recipient'''
 
|| Please type a valid''' email address''' for '''feedback.recipient'''
−
 
  
 
If a '''user''' submits any feedback in '''DSpace''', then those feedback will be sent to this '''email id'''.
 
If a '''user''' submits any feedback in '''DSpace''', then those feedback will be sent to this '''email id'''.
−
 
  
 
Here also I will type the value as '''dspace.u1@gmail.com'''
 
Here also I will type the value as '''dspace.u1@gmail.com'''
Line 180: Line 153:
 
|| System administrator email
 
|| System administrator email
 
|| We have to give a valid '''email address''' for '''mail.admin.'''
 
|| We have to give a valid '''email address''' for '''mail.admin.'''
−
 
  
 
'''System notifications '''and '''administration emails''' will be sent to '''mail.admin address'''.
 
'''System notifications '''and '''administration emails''' will be sent to '''mail.admin address'''.
−
 
  
 
I will type the value as [mailto:dspace.u1@gmail.com dspace.u1@gmail.com] '''here.
 
I will type the value as [mailto:dspace.u1@gmail.com dspace.u1@gmail.com] '''here.
Line 189: Line 160:
 
|| '''Mail.extraproperties >> '''remove # symbol
 
|| '''Mail.extraproperties >> '''remove # symbol
 
|| Next, we will configure the''' SMTP port''' '''(SSL): 465.'''
 
|| Next, we will configure the''' SMTP port''' '''(SSL): 465.'''
−
 
  
 
Scroll down and locate the line '''<nowiki>#mail.extraproperties.</nowiki>'''
 
Scroll down and locate the line '''<nowiki>#mail.extraproperties.</nowiki>'''
−
 
  
 
Remove '''<nowiki># </nowiki>'''symbol at the beginning '''mail.extraproperties.'''
 
Remove '''<nowiki># </nowiki>'''symbol at the beginning '''mail.extraproperties.'''
Line 204: Line 173:
 
|| Slide : Rebuild '''DSpace'''
 
|| Slide : Rebuild '''DSpace'''
 
|| Whenever we customize '''DSpace''', it is necessary to '''rebuild''' '''DSpace'''.
 
|| Whenever we customize '''DSpace''', it is necessary to '''rebuild''' '''DSpace'''.
−
 
  
 
'''Rebuild''' process involves*Compilation of''' source code'''
 
'''Rebuild''' process involves*Compilation of''' source code'''
 
*Installation of '''Webapp'''
 
*Installation of '''Webapp'''
 
*Deployment of '''DSpace''' on '''Tomcat server'''.
 
*Deployment of '''DSpace''' on '''Tomcat server'''.
−
 
−
 
−
 
−
 
  
 
We will prepare a''' shell script''' to '''rebuild''' '''DSpace''', and use it whenever required.
 
We will prepare a''' shell script''' to '''rebuild''' '''DSpace''', and use it whenever required.
Line 222: Line 186:
 
|-  
 
|-  
 
|| [Terminal] type:  
 
|| [Terminal] type:  
−
 
  
 
'''sudo service tomcat8 stop’’’
 
'''sudo service tomcat8 stop’’’
Line 240: Line 203:
 
'''sudo service tomcat8 start'''
 
'''sudo service tomcat8 start'''
 
|| Type the '''shell commands''' as shown in the '''text editor'''.
 
|| Type the '''shell commands''' as shown in the '''text editor'''.
−
 
  
 
We have used these '''commands''' in the earlier tutorial to '''build dspace'''.
 
We have used these '''commands''' in the earlier tutorial to '''build dspace'''.
−
 
−
 
  
 
|-  
 
|-  
Line 251: Line 211:
 
|-  
 
|-  
 
|| [Terminal] type:  
 
|| [Terminal] type:  
−
 
  
 
'''sudo chmod 777 $HOME/Rebuild-DSpace'''
 
'''sudo chmod 777 $HOME/Rebuild-DSpace'''
 
|| Type the '''command''' as shown to provide '''executable permissions''' to '''Rebuild-DSpace.'''
 
|| Type the '''command''' as shown to provide '''executable permissions''' to '''Rebuild-DSpace.'''
−
 
  
 
If prompted, enter the''' admin password''' to proceed further.
 
If prompted, enter the''' admin password''' to proceed further.
Line 263: Line 221:
 
'''$HOME/Rebuild-DSpace'''
 
'''$HOME/Rebuild-DSpace'''
 
|| Let us '''rebuild''' '''DSpace''' by typing the following '''command'''.
 
|| Let us '''rebuild''' '''DSpace''' by typing the following '''command'''.
−
 
  
 
The''' rebuild process''' may take some time depending upon your internet speed.
 
The''' rebuild process''' may take some time depending upon your internet speed.
 
|-  
 
|-  
 
|| [Terminal] Highlight
 
|| [Terminal] Highlight
−
 
  
 
'''BUILD SUCCESSFUL'''
 
'''BUILD SUCCESSFUL'''
Line 278: Line 234:
 
|| Narration only
 
|| Narration only
 
|| Next we have to '''configure''' some '''settings''' in the '''Gmail account''' which we have used.
 
|| Next we have to '''configure''' some '''settings''' in the '''Gmail account''' which we have used.
−
 
  
 
To access '''gmail''' through '''DSpace''', '''less secure apps''' in '''gmail''' '''settings''' should be turned '''ON'''.
 
To access '''gmail''' through '''DSpace''', '''less secure apps''' in '''gmail''' '''settings''' should be turned '''ON'''.
Line 289: Line 244:
 
[https://www.google.com/settings/security/lesssecureapps https://www.google.com/settings/security/lesssecureapps]
 
[https://www.google.com/settings/security/lesssecureapps https://www.google.com/settings/security/lesssecureapps]
 
|| Then in the '''address bar''', type the '''URL '''as shown.
 
|| Then in the '''address bar''', type the '''URL '''as shown.
−
 
−
 
  
 
|-  
 
|-  
Line 300: Line 253:
  
 
Now let us send a '''test mail'''.
 
Now let us send a '''test mail'''.
−
 
  
 
To do so, go to the '''terminal.'''
 
To do so, go to the '''terminal.'''
 
|-  
 
|-  
 
|| [Terminal] type:  
 
|| [Terminal] type:  
−
 
  
 
'''sudo $HOME/dspace-install/bin/dspace test-email'''
 
'''sudo $HOME/dspace-install/bin/dspace test-email'''
 
|| Then type this '''command''' to send a '''test email'''.
 
|| Then type this '''command''' to send a '''test email'''.
−
 
  
 
'''Test email''' will be sent to the '''mail id '''which was set in '''mail.admin '''in '''dspace.cfg '''file.
 
'''Test email''' will be sent to the '''mail id '''which was set in '''mail.admin '''in '''dspace.cfg '''file.
Line 315: Line 265:
 
|| [Browser] Open the gmail account
 
|| [Browser] Open the gmail account
 
|| Let us cross verify this.
 
|| Let us cross verify this.
−
 
  
 
Switch to the '''browser''' where our '''mail account''' is logged in.
 
Switch to the '''browser''' where our '''mail account''' is logged in.
−
 
  
 
Now check the '''Inbox''' for new mail.
 
Now check the '''Inbox''' for new mail.
Line 324: Line 272:
 
|| [Browser] Point to the DSpace test mail
 
|| [Browser] Point to the DSpace test mail
 
|| Here is the '''DSpace test email.'''
 
|| Here is the '''DSpace test email.'''
−
 
  
 
We have successfully '''configured''' the '''mail configuration''' and also sent a '''test mail''' in '''DSpace'''.
 
We have successfully '''configured''' the '''mail configuration''' and also sent a '''test mail''' in '''DSpace'''.
Line 333: Line 280:
 
|| Only Narration
 
|| Only Narration
 
|| This brings us to the end of this tutorial.
 
|| This brings us to the end of this tutorial.
−
 
  
 
Let us summarize.
 
Let us summarize.
 
|-  
 
|-  
 
|| Slide Summary
 
|| Slide Summary
−
 
−
 
  
 
|| In this tutorial we learnt to*Configure '''email''' for '''DSpace'''
 
|| In this tutorial we learnt to*Configure '''email''' for '''DSpace'''
 
*Prepare a '''shell script''' to '''rebuild DSpace '''and
 
*Prepare a '''shell script''' to '''rebuild DSpace '''and
 
*Sent '''test email''' from '''DSpace'''
 
*Sent '''test email''' from '''DSpace'''
−
 
  
 
|-  
 
|-  
 
|| 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.'''
−
 
  
 
Please download and watch it.
 
Please download and watch it.
 
|-  
 
|-  
 
|| Slide : Spoken Tutorial workshops
 
|| Slide : Spoken Tutorial workshops
−
 
−
 
  
 
|| The '''Spoken Tutorial Project''' team conducts workshops and gives certificates.
 
|| The '''Spoken Tutorial Project''' team conducts workshops and gives certificates.
−
 
  
 
For more details, please write to us.
 
For more details, please write to us.
Line 369: Line 308:
 
|-  
 
|-  
 
|| Slide: Acknowledgement -II
 
|| Slide: Acknowledgement -II
−
 
−
 
  
 
|| '''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.
 
|-  
 
|-  
 
|| Narration only
 
|| Narration only
−
 
−
 
  
 
|| This script and video for this tutorial was contributed by '''Pankaj Patil''' from''' IIT Bombay.'''
 
|| This script and video for this tutorial was contributed by '''Pankaj Patil''' from''' IIT Bombay.'''
−
 
  
 
This is '''Nancy Varkey '''signing off. Thank you for joining.
 
This is '''Nancy Varkey '''signing off. Thank you for joining.
 
|-
 
|-
 
|}
 
|}

Revision as of 12:39, 1 June 2020

Script : Email Configuration for DSpace


Author : Pankaj Patil


Keywords: DSpace Rebuild, DSpace Email Configuration, dspace.cfg, Rebuild script, DSpace gmail configuration


Visual Cue Narration
Slide: Title Welcome to this Spoken Tutorial on Email Configuration for DSpace.
Slide: Learning Objectives In this tutorial, we will learn to
  • Configure an email for DSpace
  • Prepare a shell script to rebuild DSpace
  • Send a test email from DSpace
Slide: System requirements This tutorial is recorded using
  • Ubuntu Linux OS 18.04
  • DSpace version 6.3
  • gedit text editor and
  • Firefox web browser

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

Slide: Pre-requisites To practice this tutorial,
  • You should have installed DSpace 6.3 and
  • You should have a working internet connection.
Slide: Pre-requisites Pre-requisites:
  • You should have familiarity with basic Linux commands.
  • If not then 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 the 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.

Slide : Necessity of Email Configuration In DSpace we have to configure the email settings to send emails from DSpace.
Slide : Necessity of Email Configuration DSpace sends emails to the users for various activities such as *Email verification during registration
  • Notification emails during Item submission and review
  • Getting Dspace user’s feedback and
  • Notifications to Community and Collection subscribers
Only Narration 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 password of the admin user to login.

[Terminal] type:

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

Type the command as shown to open dspace configuration file.

If prompted, type the root user password.

dspace.cfg file opens in the gedit text editor.

Point to Email settings Scroll down and locate the Email settings section.
Slide: SMTP Services DSpace requires SMTP service to send and receive emails.

SMTP services like Gmail, SendinBlue, SendGrid, Pepipost, Amazon SES or Mandrill can be used.

Additionally, custom SMTP services can also be set up and used.

mail.server = smtp.gmail.com In this demonstration, I will configure a Gmail SMTP mail server.

So, first I’ll set the value for mail.server as smtp.gmail.com

mail.server.username =dspace.u1@gmail.com

mail.server.password =d$pace2019*

Next we have to enter a valid gmail ID for mail.server.username.

I will use the admin’s mail id, which is dspace.u1@gmail.com

You can also use the same email id which you gave as your admin mail id.

The value for mail.server.password has to be the password of dspace.u1@gmail.com.

The typed password will be visible to everyone.

So I have blurred it for this demonstration.

Comment

mail.server.port

We will use gmail’s SMTP port (SSL): 465, to connect to the SMTP server.

So, let us disable the default SMTP port which is 25.

To do so, type # in front of the line mail.server.port.

From Address for mail Now, give a valid email address for mail.from.address.

This email id will be considered as the from address for the recipients.

Here I will type the value as dspace.u1@gmail.com

Feedback recipient email Please type a valid email address for feedback.recipient

If a user submits any feedback in DSpace, then those feedback will be sent to this email id.

Here also I will type the value as dspace.u1@gmail.com

System administrator email We have to give a valid email address for mail.admin.

System notifications and administration emails will be sent to mail.admin address.

I will type the value as dspace.u1@gmail.com here.

Mail.extraproperties >> remove # symbol Next, we will configure the SMTP port (SSL): 465.

Scroll down and locate the line #mail.extraproperties.

Remove # symbol at the beginning mail.extraproperties.

Remove # symbol Also, remove # symbol at the beginning of the next two consecutive lines, as shown.
Save and close file Save and close the file.
Slide : Rebuild DSpace Whenever we customize DSpace, it is necessary to rebuild DSpace.

Rebuild process involves*Compilation of source code

  • Installation of Webapp
  • Deployment of DSpace on Tomcat server.

We will prepare a shell script to rebuild DSpace, and use it whenever required.

[Terminal] type:

sudo gedit $HOME/Rebuild-DSpace

Open a new file named Rebuild-DSpace in a text editor.
[Terminal] type:

sudo service tomcat8 stop’’’

sleep 5

cd /home/dspace/dspace-6.3-src-release

mvn -U clean package’’’

cd /home/dspace/dspace-6.3-src-release/dspace/target/dspace-installer

ant update

sleep 5

sudo service tomcat8 start

Type the shell commands as shown in the text editor.

We have used these commands in the earlier tutorial to build dspace.

Press Ctrl+S keys Save and close the file.
[Terminal] type:

sudo chmod 777 $HOME/Rebuild-DSpace

Type the command as shown to provide executable permissions to Rebuild-DSpace.

If prompted, enter the admin password to proceed further.

[Terminal] type:

$HOME/Rebuild-DSpace

Let us rebuild DSpace by typing the following command.

The rebuild process may take some time depending upon your internet speed.

[Terminal] Highlight

BUILD SUCCESSFUL

On successful completion, BUILD SUCCESSFUL message will appear on the screen.
Narration only This means we have deployed DSpace email configuration on Tomcat server.
Narration only Next we have to configure some settings in the Gmail account which we have used.

To access gmail through DSpace, less secure apps in gmail settings should be turned ON.

[browser] Login to gmail as dspace.u1@gmail.com To do so, login to the respective gmail account which we have typed in the Email settings of DSpace.
[browser] Type the url:

https://www.google.com/settings/security/lesssecureapps

Then in the address bar, type the URL as shown.
[browser] Turn the toggle on for Allow less secure apps Turn ON the toggle button for Allow less secure apps.
Only narration We have done the required configurations.

Now let us send a test mail.

To do so, go to the terminal.

[Terminal] type:

sudo $HOME/dspace-install/bin/dspace test-email

Then type this command to send a test email.

Test email will be sent to the mail id which was set in mail.admin in dspace.cfg file.

[Browser] Open the gmail account Let us cross verify this.

Switch to the browser where our mail account is logged in.

Now check the Inbox for new mail.

[Browser] Point to the DSpace test mail Here is the DSpace test email.

We have successfully configured the mail configuration and also sent a test mail in DSpace.

Logout from gmail Once done, sign out from the gmail account.
Only Narration This brings us to the end of this tutorial.

Let us summarize.

Slide Summary In this tutorial we learnt to*Configure email for DSpace
  • Prepare a shell script to rebuild DSpace and
  • Sent test email from DSpace
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.

This is Nancy Varkey signing off. Thank you for joining.

Contributors and Content Editors

Nancyvarkey, Pankajpatil694, Pravin1389

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