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