Merge branch 'master' of git://git.koha-community.org/koha into MSWin32
[wip/koha-chris_n.git] / misc / cronjobs / CONFIGURE.gmail
1 =============================
2 Installation Guide for Configuring a Koha Server to Use a Gmail Account as its SMTP Server
3 =============================
4
5 Copyright (C) 2010 Foundations Bible College (http://www.foundations.edu)
6
7 Author: Chris Nighswonger (cnighswonger AT foundations DOT edu
8
9 Feedback/bug reports: Koha Developer's List:
10 http://lists.koha.org/mailman/listinfo/koha-devel
11
12 This document last modified: 13 February 2010
13
14 Configuration Instructions
15 =============================
16
17 To use your gmail account as an SMTP server you will need to execute the following from a shell prompt.
18
19 (These steps are taken from http://jonspriggs.posterous.com/use-gmails-smtp-gateway-using-the-command-lin)
20
21 sudo apt-get install openssl xinetd
22
23 sudo tee /usr/bin/gmail-smtp <<EOF >/dev/null
24 #!/bin/sh
25 # Thanks to http://ubuntuforums.org/showthread.php?t=918335 for this install guide
26 /usr/bin/openssl s_client -connect smtp.gmail.com:465 -quiet 2>/dev/null
27 EOF
28 sudo chmod +x /usr/bin/gmail-smtp
29
30 sudo tee /etc/xinetd.d/gmail-smtp <<EOF >/dev/null
31 # default: on
32 # description: Gmail SMTP wrapper for clients without SSL support
33 # Thanks to http://ubuntuforums.org/showthread.php?t=918335 for this install guide
34 service gmail-smtp
35 {
36     disable         = no
37     bind            = localhost
38     port            = 10025
39     socket_type     = stream
40     protocol        = tcp
41     wait            = no
42     user            = root
43     server          = /usr/bin/gmail-smtp
44     type            = unlisted
45 }
46 EOF
47 sudo /etc/init.d/xinetd reload
48
49 Edit Mail/Sendmail.pm and set the port to 10025. (Note: This file will be located where ever your Perl libraries are.)
50
51 Script Setup Instructions
52 =============================
53
54 After successfully executing the above steps, you will need to run the process_message_queue.pl script with the
55 following syntax:
56
57 perl process_message_queue.pl -u librarian@foo.tld -p supersecret -m LOGIN
58
59 This, of course, assumes that you have all other scripts in place and functional to generate notices.
60
61 Misc Helpful Notes
62 =============================
63
64 NOTE: In order to debug problems, you can set the debug level in Mail/Sendmail.pm to 11 which will give plenty of
65 commentary to STDOUT.