diff --git a/README.md b/README.md index d4c7cfc..9c55041 100644 --- a/README.md +++ b/README.md @@ -18,14 +18,39 @@ MailHog is an email testing tool for developers: * View messages in the web UI, or retrieve them with the JSON API * Optionally release messages to real SMTP servers for delivery -### Getting started +### Installation -1. Either: - * [Download the latest release](/docs/RELEASES.md) of MailHog for your platform - * [Run it from Docker Hub](https://registry.hub.docker.com/r/mailhog/mailhog/) or using the provided [Dockerfile](Dockerfile) - * [Read the deployment guide](/docs/DEPLOY.md) for other deployment options - * Install it with Homebrew on MacOS - `brew update && brew install mailhog` -2. [Configure MailHog](/docs/CONFIG.md), or use the default settings: +#### Manual installation +[Download the latest release for your platform](/docs/RELEASES.md). Then +[read the deployment guide](/docs/DEPLOY.md) for deployment options. + +#### MacOS +```bash +brew update && brew install mailhog +``` + +Then, start MailHog by running `mailhog` in the command line. + +#### Debian / Ubuntu +```bash +sudo apt-get -y install golang-go +go get github.com/mailhog/MailHog +``` + +Then, start MailHog by running `/path/to/MailHog` in the command line. + +E.g. the path to Go's bin files on Ubuntu is `~/go/bin/`, so to start the MailHog run: + +```bash +~/go/bin/MailHog +``` + +#### Docker +[Run it from Docker Hub](https://registry.hub.docker.com/r/mailhog/mailhog/) or using the provided [Dockerfile](Dockerfile) + +### Configuration + +Check out how to [configure MailHog](/docs/CONFIG.md), or use the default settings: * the SMTP server starts on port 1025 * the HTTP server starts on port 8025 * in-memory message storage @@ -62,7 +87,7 @@ You can also use `MailHog sendmail ...` instead of the separate mhsendmail binar Alternatively, you can use your native `sendmail` command by providing `-S`, for example: -``` +```bash /usr/sbin/sendmail -S mail:1025 ```