updated documentation

git-svn-id: http://easypost.googlecode.com/svn/trunk@4 4c8e1b94-4054-0410-9f97-17490ffc63a7

Author: jelleherold

docs/easypost.html

@@ -309,18 +309,22 @@ <h1><a id="requirements" name="requirements">Requirements</a></h1>
 </div>
 <div class="section">
 <h1><a id="setup" name="setup">Setup</a></h1>
+<p>We shall be needing a password for the database user, so we generate a 12
+character long password consisting of numeric, capital and lowercase characters.</p>
+<p><tt class="docutils literal"><span class="pre">apg</span> <span class="pre">-M</span> <span class="pre">NCL</span> <span class="pre">-n1</span> <span class="pre">-m12</span> <span class="pre">-x12</span></tt></p>
 <div class="section">
 <h2><a id="postgresql" name="postgresql">Postgresql</a></h2>
 <p>First, postgresql setup. We create a password protected user
 with limited capabilities, called <tt class="docutils literal"><span class="pre">easypost</span></tt>. The password
 is encrypted using MD5 (see <tt class="docutils literal"><span class="pre">man</span> <span class="pre">createuser</span></tt> for details).
-Also, create a database called <tt class="docutils literal"><span class="pre">easypost</span></tt> for this user.:</p>
+Also, we create a database called <tt class="docutils literal"><span class="pre">easypost</span></tt> for this user.:</p>
 <pre class="literal-block">
 sudo -u postgres bash
 createuser -DRESP easypost
 createdb -O easypost easypost
 exit
 </pre>
+<p>(you enter the password we generated earlier)</p>
 <p>We are running postfix and postgresql on the same system. So
 we first configure postgres to accept connections from user.
 Add the following line to
@@ -330,8 +334,9 @@ <h2><a id="postgresql" name="postgresql">Postgresql</a></h2>
 host  easypost easypost 127.0.0.1/32 md5
 </pre>
 <p>(Make sure this is above the line that says <tt class="docutils literal"><span class="pre">local</span> <span class="pre">all</span> <span class="pre">all</span>
-<span class="pre">ident</span> <span class="pre">sameuser</span></tt>. Also, the second line is nog needed if there
+<span class="pre">ident</span> <span class="pre">sameuser</span></tt>. Also, the second line is not needed if there
 is a line like <tt class="docutils literal"><span class="pre">host</span> <span class="pre">all</span> <span class="pre">all</span> <span class="pre">127.0.0.1/32</span> <span class="pre">md5</span></tt>.)</p>
+<p>Now restart postgresql with <tt class="docutils literal"><span class="pre">/etc/init.d/postgresql-8.3</span> <span class="pre">restart</span></tt>.</p>
 <p>That's it. You can test this (as any user) with::</p>
 <pre class="literal-block">
 psql easypost -U easypost
@@ -392,6 +397,13 @@ <h2><a id="listing-database-contents" name="listing-database-contents">Listing d
 <p><tt class="docutils literal"><span class="pre">easypost</span> <span class="pre">list</span> <span class="pre">domains</span> <span class="pre">[--user</span> <span class="pre">&lt;username&gt;]</span></tt></p>
 </div>
 </div>
+</div>
+<div class="footer">
+<hr class="footer" />
+<a class="reference" href="easypost.rst">View document source</a>.
+Generated on: 2008-10-08 12:02 UTC.
+Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
+
 </div>
 </body>
 </html>

docs/easypost.rst

@@ -21,19 +21,27 @@ This is intended for Debian/Ubuntu based systems. Minimum requirements:
 Setup
 =====
 
+We shall be needing a password for the database user, so we generate a 12
+character long password consisting of numeric, capital and lowercase characters.
+
+``apg -M NCL -n1 -m12 -x12``
+
+
 Postgresql
 ----------
 
 First, postgresql setup. We create a password protected user
 with limited capabilities, called ``easypost``. The password
 is encrypted using MD5 (see ``man createuser`` for details).
-Also, create a database called ``easypost`` for this user.::
+Also, we create a database called ``easypost`` for this user.::
 
   sudo -u postgres bash
   createuser -DRESP easypost
   createdb -O easypost easypost
   exit
 
+(you enter the password we generated earlier)
+
 We are running postfix and postgresql on the same system. So
 we first configure postgres to accept connections from user.
 Add the following line to
@@ -43,9 +51,11 @@ Add the following line to
  host  easypost easypost 127.0.0.1/32 md5
 
 (Make sure this is above the line that says ``local all all
-ident sameuser``. Also, the second line is nog needed if there
+ident sameuser``. Also, the second line is not needed if there
 is a line like ``host all all 127.0.0.1/32 md5``.)
 
+Now restart postgresql with ``/etc/init.d/postgresql-8.3 restart``.
+
 That's it. You can test this (as any user) with:::
 
   psql easypost -U easypost