Skip to content
This repository has been archived by the owner on Nov 30, 2017. It is now read-only.

Commit

Permalink
Rename cookbook
Browse files Browse the repository at this point in the history
Rename cookbook to "mailcatcher-ng".
Update documentation to have a valid markdown markup.
  • Loading branch information
Geza Buza committed Sep 27, 2015
1 parent cc56098 commit 9572499
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 61 deletions.
74 changes: 15 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,23 @@
MailCatcher Cookbook
mailcatcher-ng Cookbook
====================
Allows for installation of MailCatcher on CentOS boxes.

Recipes
----------
<table>
<tr>
<th>Name</th>
<th>Explanation</th>
</tr>
<tr>
<td><tt>mailcatcher</tt></td>
<td>Basic installation of MailCatcher</td>
</tr>
<tr>
<td><tt>mailcatcher::php</tt></td>
<td>Sets the php <tt>sendmail_path</tt> to use MailCatcher</td>
</tr>
</table>

| Name | Explanation |
| ----------------- | ------------------------------------------------- |
| mailcatcher | Basic installation of MailCatcher |
| mailcatcher::php | Sets the php *sendmail_path* to use MailCatcher |

Attributes
----------
<table>
<tr>
<th>Key</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><tt>['mailcatcher']['bin']</tt></td>
<td>String</td>
<td>The location of the MailCatcher binary file</td>
<td><tt>mailcatcher</tt></td>
</tr>
<tr>
<td><tt>['mailcatcher']['smtp_ip']</tt></td>
<td>String</td>
<td>The ip address of the smtp server</td>
<td><tt>127.0.0.1</tt></td>
</tr>
<tr>
<td><tt>['mailcatcher']['smtp_port']</tt></td>
<td>Integer</td>
<td>The port of the smtp server</td>
<td><tt>1025</tt></td>
</tr>
<tr>
<td><tt>['mailcatcher']['http_ip']</tt></td>
<td>String</td>
<td>The ip address of the http server</td>
<td><tt>0.0.0.0</tt></td>
</tr>
<tr>
<td><tt>['mailcatcher']['http_port']</tt></td>
<td>Integer</td>
<td>The port of the http server</td>
<td><tt>1080</tt></td>
</tr>
<tr>
<td><tt>['mailcatcher']['catchmail_bin']</tt></td>
<td>String</td>
<td>The location of the CatchMail binary file</td>
<td><tt>catchmail</tt></td>
</tr>
</table>

| Key | Type | Description | Default |
| --------------------------------- | --------- | --------------------------------------------- | ------------- |
| ['mailcatcher']['bin'] | String | The location of the MailCatcher binary file | mailcatcher |
| ['mailcatcher']['smtp_ip'] | String | The ip address of the smtp server | 127.0.0.1 |
| ['mailcatcher']['smtp_port'] | Integer | The port of the smtp server | 1025 |
| ['mailcatcher']['http_ip'] | String | The ip address of the http server | 0.0.0.0 |
| ['mailcatcher']['http_port'] | Integer | The port of the http server | 1080 |
| ['mailcatcher']['catchmail_bin'] | String | The location of the CatchMail binary file | catchmail |
4 changes: 2 additions & 2 deletions metadata.rb
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name "mailcatcher"
name "mailcatcher-ng"
maintainer "Inviqa"
license "Apache 2.0"
description "Allows for installation of MailCatcher on CentOS boxes."
version "0.0.1"
version "0.0.2"

depends "rbenv"

Expand Down

0 comments on commit 9572499

Please sign in to comment.