ric/MailHog
1
0
Fork 0
mirror of https://gitlab.com/ric_harvey/MailHog.git synced 2025-02-17 08:15:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make naming more consistent

Browse source
This commit is contained in:
Ian Kent 2014-12-24 17:57:47 +00:00
parent 1785b3db7f
commit 35dc20d1b8
5 changed files with 15 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
APIv1.md
View file

@ -1,5 +1,5 @@
Go-MailHog API v1 MailHog API v1
================= ==============
The v1 API is a RESTful HTTP JSON API. The v1 API is a RESTful HTTP JSON API.

2
CONFIG.md
View file

@ -1,7 +1,7 @@
Configuring MailHog 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 | Environment | Command line | Default | Description
| ------------------- | ------------- | --------------- | ----------- | ------------------- | ------------- | --------------- | -----------

11
DEPLOY.md
View file

@ -5,8 +5,8 @@ Deploying MailHog
You can run MailHog locally from the command line. You can run MailHog locally from the command line.
go get github.com/ian-kent/MailHog/MailHog go get github.com/mailhog/MailHog
MailHog MailHog -h
To configure MailHog, use the environment variables or command line flags To configure MailHog, use the environment variables or command line flags
described in the [README](README.md). 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 ### 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 1. Open the Elastic Beanstalk console
2. Create a zip file containing the Dockerfile and MailHog binary 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 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 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: To configure your Elastic Beanstalk MailHog instance, either:
* Set environment variables using the Elastic Beanstalk console * Set environment variables using the Elastic Beanstalk console
* Edit the Dockerfile to pass in command line arguments * 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.

6
README.md
View file

@ -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. 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. 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 ### Getting started
1. Either: 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 * [Read the deployment guide](DEPLOY.md) for other deployment options
2. [Configure MailHog](CONFIG.md), or use the default settings: 2. [Configure MailHog](CONFIG.md), or use the default settings:
* the SMTP server will start on port 1025 * the SMTP server will start on port 1025

4
RELEASES.md
View file

@ -1,5 +1,5 @@
Go-MailHog Releases MailHog Releases
=================== ================
### [v0.08](https://github.com/mailhog/MailHog/releases/0.08) ### [v0.08](https://github.com/mailhog/MailHog/releases/0.08)