~jorge/charms/precise/postfix/fix-readme

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Jorge O. Castro
  • Date: 2014-02-05 13:32:18 UTC
  • Revision ID: jorge@ubuntu.com-20140205133218-wrgx6xae80tvds5h
Reformat to Markdown

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Overview
2
 
--------
 
1
# Overview
3
2
 
4
3
Postfix is Wietse Venema's mail transport agent that started life as an
5
4
alternative to the widely-used Sendmail program. Postfix attempts to be fast,
14
13
REMINDER: This charm does not include a configuration for a web interface.
15
14
 
16
15
 
17
 
Usage
18
 
-----
 
16
# Usage
19
17
 
20
18
To deploy Postfix, you first need to edit the config.yaml with your own
21
19
configuration options. This is because some certificates will be created once
31
29
 
32
30
once the service has finished deploying.
33
31
 
34
 
 
35
 
Configuration
36
 
-------------
 
32
# Configuration
37
33
 
38
34
To configure the charm, you need to edit the config.yaml file that comes here,
39
35
setting the values to your current values. More information on the add-ssl and
40
36
options can be found on the config.yaml file itself.
41
37
 
42
 
hostname: This is the hostname you assigned for the server, not the rDNS
43
 
 
44
 
domain: This is the domain you will be using for the server (what, in the email
45
 
address, goes after the @)
46
 
 
47
 
rootuser: The root username (it is usually root or ubuntu)
48
 
 
49
 
ssl-key: The SSL key on your system, which should be stated as `cat
 
38
`hostname`: This is the hostname you assigned for the server, not the rDNS
 
39
 
 
40
`domain`: This is the domain you will be using for the server (what, in the email address, goes after the @)
 
41
 
 
42
`rootuser`: The root username (it is usually root or ubuntu)
 
43
 
 
44
`ssl-key`: The SSL key on your system, which should be stated as `cat
50
45
~/smtpd.key`
51
46
 
52
 
ssl-cert: The SSL certificate on your system, which should be stated as `cat
 
47
`ssl-cert`: The SSL certificate on your system, which should be stated as `cat
53
48
~/smtpd.crt`
54
49
 
55
 
cacert: The cacert.pem file you generated on your system, which should be
 
50
`cacert`: The cacert.pem file you generated on your system, which should be
56
51
stated as `cat ~/cacert.pem`
57
52
 
58
 
cakey: The cakey.pem file you generated on your system, which should be
 
53
`cakey`: The cakey.pem file you generated on your system, which should be
59
54
stated as `cat ~/cakey.pem`
60
55
 
61
 
 
62
 
Adding TLS/SSL support
63
 
----------------------
 
56
## Adding TLS/SSL support
64
57
 
65
58
This charm has Transport Socket Layer (TLS) and Secure Socket Layer (SSL)
66
59
support. Even though this option is not necessary, it is highly recommended. To
68
61
will have to follow the instructions below for generating keys/certificates (in
69
62
case you do not have them yet) and placing them in the correct directories.
70
63
 
71
 
Generating the keys and certificates
72
 
------------------------------------
 
64
## Generating the keys and certificates
73
65
 
74
66
In case you want to add TLS/SSL to this charm you will need to use keys and SSL
75
67
certificates. If you already have those done, please skip to the bottom of this
78
70
To generate self-signed certificates, you need to issue the following commands
79
71
on a Terminal:
80
72
 
81
 
  touch smtpd.key
82
 
 
83
 
  chmod 600 smtpd.key
84
 
 
85
 
  openssl genrsa 1024 > smtpd.key openssl req -new -key smtpd.key -x509 -days
 
73
    touch smtpd.key
 
74
    chmod 600 smtpd.key
 
75
    openssl genrsa 1024 > smtpd.key openssl req -new -key smtpd.key -x509 -days
86
76
  3650 -out smtpd.crt
87
 
 
88
 
  openssl req -new -x509 -extensions v3_ca -keyout cakey.pem -out cacert.pem
 
77
    openssl req -new -x509 -extensions v3_ca -keyout cakey.pem -out cacert.pem
89
78
  -days 3650
90
79
 
91
80
Please, note that the third and fourth commands have prompts you have to fill
94
83
Once you have generated the certificates, you can go ahead and execute the
95
84
following command:
96
85
 
97
 
  juju set postfix ssl-key="`cat ~/smtpd.key`" ssl-cert="`cat ~/smtpd.crt`"
 
86
    juju set postfix ssl-key="`cat ~/smtpd.key`" ssl-cert="`cat ~/smtpd.crt`"
98
87
  cacert="`cat ~/cacert.pem`" cakey="`~/cakey.pem`"
99
88
 
100
 
 
101
 
Renewing the keys and certificates
102
 
----------------------------------
 
89
## Renewing the keys and certificates
103
90
 
104
91
The renewal of keys and SSL certificates can be done in the same way that you
105
92
added SSL support. Just re-run the following command, specifying the new
106
93
certificates and keys locations instead of the old ones:
107
94
 
108
 
  juju set postfix ssl-key="`cat ~/smtpd.key`" ssl-cert="`cat ~/smtpd.crt`"
 
95
    juju set postfix ssl-key="`cat ~/smtpd.key`" ssl-cert="`cat ~/smtpd.crt`"
109
96
  cacert="`cat ~/cacert.pem`" cakey="`~/cakey.pem`"
110
97
 
111
98
Once you do that, your keys and SSL certificates should be updated.
112
99
 
113
 
 
114
 
Contact Information
115
 
-------------------
 
100
# Contact Information
116
101
 
117
102
Author: José Antonio Rey <jose@ubuntu.com>
118
103
Report bugs at: http://bugs.launchpad.net/charms