ric/MailHog
1
0
Fork 0
mirror of https://gitlab.com/ric_harvey/MailHog.git synced 2024-11-27 16:24:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme

Browse source
This commit is contained in:
Ian Kent 2015-01-04 13:06:46 +00:00
parent 1f380e6a3c
commit ac93898985
1 changed files with 6 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -3,13 +3,7 @@ MailHog [ ![Download](https://img.shields.io/github/release/mailhog/MailHog.svg)
Inspired by [MailCatcher](http://mailcatcher.me/), easier to install. Inspired by [MailCatcher](http://mailcatcher.me/), easier to install.
MailHog is a rewritten version of [MailHog](https://github.com/ian-kent/MailHog), which was born out of [M3MTA](https://github.com/ian-kent/M3MTA). Built with Go - MailHog runs without installation on multiple platforms.
Go was chosen for portability - MailHog runs without installation on multiple platforms.
### Requirements
* None!
### Getting started ### Getting started
@ -18,9 +12,9 @@ Go was chosen for portability - MailHog runs without installation on multiple pl
* [Run it from Docker Hub](https://registry.hub.docker.com/u/mailhog/mailhog/) or using the provided [Dockerfile](Dockerfile) * [Run it from Docker Hub](https://registry.hub.docker.com/u/mailhog/mailhog/) or using the provided [Dockerfile](Dockerfile)
* [Read the deployment guide](/docs/DEPLOY.md) for other deployment options * [Read the deployment guide](/docs/DEPLOY.md) for other deployment options
2. [Configure MailHog](/docs/CONFIG.md), or use the default settings: 2. [Configure MailHog](/docs/CONFIG.md), or use the default settings:
* the SMTP server will start on port 1025 * the SMTP server starts on port 1025
* the HTTP server will start on port 8025 * the HTTP server starts on port 8025
* in-memory message storage will be used. * in-memory message storage
### Features ### Features
@ -45,6 +39,8 @@ Go was chosen for portability - MailHog runs without installation on multiple pl
### Contributing ### Contributing
MailHog is a rewritten version of [MailHog](https://github.com/ian-kent/MailHog), which was born out of [M3MTA](https://github.com/ian-kent/M3MTA).
Clone this repository to ```$GOPATH/src/github.com/mailhog/MailHog``` and type ```make deps```. Clone this repository to ```$GOPATH/src/github.com/mailhog/MailHog``` and type ```make deps```.
See the [Building MailHog](BUILD.md) guide. See the [Building MailHog](BUILD.md) guide.