Merge lp:~jorge/charms/precise/postfix/fix-readme into lp:charms/postfix

[Jorge Castro]

[José Antonio Rey (jose)]

I'm curious about what the difference between # and ## (used in line 110 of the diff) is.

review: Needs Information

[José Antonio Rey (jose)]

As I expected, it was an h2 tag compared to an h1 tag. Let's go for it.

review: Approve

=== renamed file 'README' => 'README.md'
--- README	2014-01-29 17:43:25 +0000
+++ README.md	2014-02-05 13:34:27 +0000
@@ -1,5 +1,4 @@
-Overview
---------
+# Overview
 
 Postfix is Wietse Venema's mail transport agent that started life as an
 alternative to the widely-used Sendmail program. Postfix attempts to be fast,
@@ -14,8 +13,7 @@
 REMINDER: This charm does not include a configuration for a web interface.
 
 
-Usage
------
+# Usage
 
 To deploy Postfix, you first need to edit the config.yaml with your own
 configuration options. This is because some certificates will be created once
@@ -31,36 +29,31 @@
 
 once the service has finished deploying.
 
-
-Configuration
--------------
+# Configuration
 
 To configure the charm, you need to edit the config.yaml file that comes here,
 setting the values to your current values. More information on the add-ssl and
 options can be found on the config.yaml file itself.
 
-hostname: This is the hostname you assigned for the server, not the rDNS
-
-domain: This is the domain you will be using for the server (what, in the email
-address, goes after the @)
-
-rootuser: The root username (it is usually root or ubuntu)
-
-ssl-key: The SSL key on your system, which should be stated as `cat
+`hostname`: This is the hostname you assigned for the server, not the rDNS
+
+`domain`: This is the domain you will be using for the server (what, in the email address, goes after the @)
+
+`rootuser`: The root username (it is usually root or ubuntu)
+
+`ssl-key`: The SSL key on your system, which should be stated as `cat
 ~/smtpd.key`
 
-ssl-cert: The SSL certificate on your system, which should be stated as `cat
+`ssl-cert`: The SSL certificate on your system, which should be stated as `cat
 ~/smtpd.crt`
 
-cacert: The cacert.pem file you generated on your system, which should be
+`cacert`: The cacert.pem file you generated on your system, which should be
 stated as `cat ~/cacert.pem`
 
-cakey: The cakey.pem file you generated on your system, which should be
+`cakey`: The cakey.pem file you generated on your system, which should be
 stated as `cat ~/cakey.pem`
 
-
-Adding TLS/SSL support
-----------------------
+## Adding TLS/SSL support
 
 This charm has Transport Socket Layer (TLS) and Secure Socket Layer (SSL)
 support. Even though this option is not necessary, it is highly recommended. To
@@ -68,8 +61,7 @@
 will have to follow the instructions below for generating keys/certificates (in
 case you do not have them yet) and placing them in the correct directories.
 
-Generating the keys and certificates
-------------------------------------
+## Generating the keys and certificates
 
 In case you want to add TLS/SSL to this charm you will need to use keys and SSL
 certificates. If you already have those done, please skip to the bottom of this
@@ -78,14 +70,11 @@
 To generate self-signed certificates, you need to issue the following commands
 on a Terminal:
 
-  touch smtpd.key
-
-  chmod 600 smtpd.key
-
-  openssl genrsa 1024 > smtpd.key openssl req -new -key smtpd.key -x509 -days
+    touch smtpd.key
+    chmod 600 smtpd.key
+    openssl genrsa 1024 > smtpd.key openssl req -new -key smtpd.key -x509 -days
   3650 -out smtpd.crt
-
-  openssl req -new -x509 -extensions v3_ca -keyout cakey.pem -out cacert.pem
+    openssl req -new -x509 -extensions v3_ca -keyout cakey.pem -out cacert.pem
   -days 3650
 
 Please, note that the third and fourth commands have prompts you have to fill
@@ -94,25 +83,21 @@
 Once you have generated the certificates, you can go ahead and execute the
 following command:
 
-  juju set postfix ssl-key="`cat ~/smtpd.key`" ssl-cert="`cat ~/smtpd.crt`"
+    juju set postfix ssl-key="`cat ~/smtpd.key`" ssl-cert="`cat ~/smtpd.crt`"
   cacert="`cat ~/cacert.pem`" cakey="`~/cakey.pem`"
 
-
-Renewing the keys and certificates
-----------------------------------
+## Renewing the keys and certificates
 
 The renewal of keys and SSL certificates can be done in the same way that you
 added SSL support. Just re-run the following command, specifying the new
 certificates and keys locations instead of the old ones:
 
-  juju set postfix ssl-key="`cat ~/smtpd.key`" ssl-cert="`cat ~/smtpd.crt`"
+    juju set postfix ssl-key="`cat ~/smtpd.key`" ssl-cert="`cat ~/smtpd.crt`"
   cacert="`cat ~/cacert.pem`" cakey="`~/cakey.pem`"
 
 Once you do that, your keys and SSL certificates should be updated.
 
-
-Contact Information
--------------------
+# Contact Information
 
 Author: José Antonio Rey <[e-mail]>
 Report bugs at: http://bugs.launchpad.net/charms