Skip to content

Commit

Permalink
Update readme and screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
ian-kent committed Apr 24, 2014
1 parent 7e467af commit c9d12d1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Go was chosen for portability - MailHog runs without installation on multiple pl
### Requirements

* None!
* Well, you need MongoDB installed somewhere

### Getting started

Expand All @@ -23,8 +22,11 @@ server will start on port 8025.
### Features

* ESMTP server implementing RFC5321
* Web interface to view messages
* API interface to list, retrieve and delete messages
* Support for SMTP AUTH (RFC4954) and PIPELINING (RFC2920)
* Web interface to view messages (plain text, HTML or source)
* HTTP API to list, retrieve and delete messages
* Multipart MIME support
* In-memory message storage
* MongoDB storage for message persistence
* Lightweight and portable
* No installation required
Expand All @@ -43,12 +45,14 @@ You can configure Go-MailHog using command line options:
| -mongodb | mailhog | MongoDB database name for message storage
| -mongouri | 127.0.0.1:27017 | MongoDB host and port
| -smtpbindaddr | 0.0.0.0:1025 | Interface and port for SMTP server to bind to
| -storage | memory | Set message storage: memory / mongodb

### Contributing

Clone this repository to ```$GOPATH/src/github.com/ian-kent/MailHog``` and type ```go install```.

Run tests using ```go test```. You'll need a copy of MailHog running for tests to pass.
(Tests currently fail using in-memory storage, use MongoDB!)

If you make any changes, run ```go fmt``` before submitting a pull request.

Expand Down
Binary file modified images/MailHog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c9d12d1

Please sign in to comment.