From 35dc20d1b8c9465fdb02363885406f5e6dfdd93a Mon Sep 17 00:00:00 2001 From: Ian Kent Date: Wed, 24 Dec 2014 17:57:47 +0000 Subject: [PATCH] Make naming more consistent --- APIv1.md | 4 ++-- CONFIG.md | 2 +- DEPLOY.md | 11 +++++++---- README.md | 6 +++--- RELEASES.md | 4 ++-- 5 files changed, 15 insertions(+), 12 deletions(-) diff --git a/APIv1.md b/APIv1.md index 0caf321..1c9a799 100644 --- a/APIv1.md +++ b/APIv1.md @@ -1,5 +1,5 @@ -Go-MailHog API v1 -================= +MailHog API v1 +============== The v1 API is a RESTful HTTP JSON API. diff --git a/CONFIG.md b/CONFIG.md index 683bc81..43a72cc 100644 --- a/CONFIG.md +++ b/CONFIG.md @@ -1,7 +1,7 @@ Configuring MailHog =================== -You can configure Go-MailHog using command line options or environment variables: +You can configure MailHog using command line options or environment variables: | Environment | Command line | Default | Description | ------------------- | ------------- | --------------- | ----------- diff --git a/DEPLOY.md b/DEPLOY.md index cb2440e..99dfea6 100644 --- a/DEPLOY.md +++ b/DEPLOY.md @@ -5,8 +5,8 @@ Deploying MailHog You can run MailHog locally from the command line. - go get github.com/ian-kent/MailHog/MailHog - MailHog + go get github.com/mailhog/MailHog + MailHog -h To configure MailHog, use the environment variables or command line flags described in the [README](README.md). @@ -24,7 +24,7 @@ The example [Dockerfile](Dockerfile) can be used to run MailHog in a [Docker](ht ### Elastic Beanstalk -You can deploy Go-MailHog using [AWS Elastic Beanstalk](http://aws.amazon.com/elasticbeanstalk/). +You can deploy MailHog using [AWS Elastic Beanstalk](http://aws.amazon.com/elasticbeanstalk/). 1. Open the Elastic Beanstalk console 2. Create a zip file containing the Dockerfile and MailHog binary @@ -32,9 +32,12 @@ You can deploy Go-MailHog using [AWS Elastic Beanstalk](http://aws.amazon.com/el 4. Launch a new environment and upload the zip file If you're using in-memory storage, you can only use a single instance of -Go-MailHog. To use a load balanced EB application, use MongoDB backed storage. +MailHog. To use a load balanced EB application, use MongoDB backed storage. To configure your Elastic Beanstalk MailHog instance, either: * Set environment variables using the Elastic Beanstalk console * Edit the Dockerfile to pass in command line arguments + +You may face restrictions on outbound SMTP from EC2, for example if you are +releasing messages to real SMTP servers. diff --git a/README.md b/README.md index 83887ca..5ecaf80 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -Go-MailHog [ ![Download](https://api.bintray.com/packages/ian-kent/generic/Go-MailHog/images/download.svg) ](https://bintray.com/ian-kent/generic/Go-MailHog/_latestVersion) [![GoDoc](https://godoc.org/github.com/mailhog/MailHog?status.svg)](https://godoc.org/github.com/mailhog/MailHog) [![Build Status](https://travis-ci.org/ian-kent/Go-MailHog.svg?branch=master)](https://travis-ci.org/ian-kent/Go-MailHog) +MailHog [ ![Download](https://api.bintray.com/packages/ian-kent/generic/Go-MailHog/images/download.svg) ](https://bintray.com/ian-kent/generic/Go-MailHog/_latestVersion) [![GoDoc](https://godoc.org/github.com/mailhog/MailHog?status.svg)](https://godoc.org/github.com/mailhog/MailHog) [![Build Status](https://travis-ci.org/mailhog/MailHog.svg?branch=master)](https://travis-ci.org/mailhog/MailHog) ========= Inspired by [MailCatcher](http://mailcatcher.me/), easier to install. -Go-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). +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). Go was chosen for portability - MailHog runs without installation on multiple platforms. @@ -14,7 +14,7 @@ Go was chosen for portability - MailHog runs without installation on multiple pl ### Getting started 1. Either: - * [Download the latest release](RELEASES.md) of Go-MailHog for your platform + * [Download the latest release](RELEASES.md) of MailHog for your platform * [Read the deployment guide](DEPLOY.md) for other deployment options 2. [Configure MailHog](CONFIG.md), or use the default settings: * the SMTP server will start on port 1025 diff --git a/RELEASES.md b/RELEASES.md index 2df9eef..4773ec5 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -1,5 +1,5 @@ -Go-MailHog Releases -=================== +MailHog Releases +================ ### [v0.08](https://github.com/mailhog/MailHog/releases/0.08)