diff --git a/README.md b/README.md index 2c7abb7..4ac8b7a 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,17 @@ fn fetch_inbox_top() -> imap::error::Result> { } ``` +## Running the test suite + +To run the integration tests, you need to have [GreenMail +running](http://www.icegreen.com/greenmail/#deploy_docker_standalone). The +easiest way to do that is with Docker: + +```console +$ docker pull greenmail/standalone:1.5.8 +$ docker run -t -i -e GREENMAIL_OPTS='-Dgreenmail.setup.test.all -Dgreenmail.hostname=0.0.0.0 -Dgreenmail.auth.disabled -Dgreenmail.verbose' -p 3025:3025 -p 3110:3110 -p 3143:3143 -p 3465:3465 -p 3993:3993 -p 3995:3995 greenmail/standalone:1.5.8 +``` + ## License Licensed under either of diff --git a/README.tpl b/README.tpl index 7d9b4c1..dd57edf 100644 --- a/README.tpl +++ b/README.tpl @@ -12,6 +12,17 @@ {{readme}} +## Running the test suite + +To run the integration tests, you need to have [GreenMail +running](http://www.icegreen.com/greenmail/#deploy_docker_standalone). The +easiest way to do that is with Docker: + +```console +$ docker pull greenmail/standalone:1.5.8 +$ docker run -t -i -e GREENMAIL_OPTS='-Dgreenmail.setup.test.all -Dgreenmail.hostname=0.0.0.0 -Dgreenmail.auth.disabled -Dgreenmail.verbose' -p 3025:3025 -p 3110:3110 -p 3143:3143 -p 3465:3465 -p 3993:3993 -p 3995:3995 greenmail/standalone:1.5.8 +``` + ## License Licensed under either of