From d06f2e4b2c2a8125e1c1a7aeb5e5490577193197 Mon Sep 17 00:00:00 2001 From: Richard Remer Date: Fri, 18 Sep 2015 15:30:40 -0700 Subject: [PATCH] finalized README, 1.0 'release' version --- README.md | 34 +++++++++++++++++++++++++++++++++- package.json | 2 +- 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index aa90d8e..01b7627 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,26 @@ SMTP to HTTP gateway Usage ----- +```sh +Usage: smtp2http [-v|--verbose] [-s|--silent|-q|--quiet] + [-T|--tls=] ENDPOINT + + -q --quiet Do not log to STDERR + -s --silent Alias for --quiet + -T --tls= colon-delimited list of cert files + q.v. TLS Option below + -v --verbose Log information to STDOUT + +TLS Option +The --tls option accepts a colon-delimited list of certificate file. +You can specify a single combined PFX file, a cert file followed by a +key file, or a cert file followed by a key file followed by a signing +authority certificate. +``` + + +Examples +-------- Begin listening for incoming SMTP messages, parse them, and post them to the specified HTTP endpoint. ```sh @@ -41,7 +61,7 @@ npm install -g Development ----------- -The SMTP protocol does not provide any way to set thc TCP port used for +The SMTP protocol does not provide any way to set the TCP port used for communication. Because of this, development can be difficult if trying to use public mail providers because you must have an internet facing server listening on port 25. @@ -58,3 +78,15 @@ In this example, `example.com` is the public server to which you have access, `root` is a user with access to open low-numbered ports on that host, `25` is the port this host will listen on (standard SMTP port), and `2025` is the port `smtp2http` will listen on. + +Appendix - Generating a PFX cert +-------------------------------- +If you have a typical PEM cert with separate key and cert files, you may wish +to generate a PFX cert which is simple to specify. + +```sh +openssl pkcs12 -export \ + -out example.com.pfx \ + -in example.com.crt -inkey example.com.key \ + -certfile example.com-ca.crt +``` \ No newline at end of file diff --git a/package.json b/package.json index ef2426b..0a5fe84 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "smtp2http", - "version": "0.0.2", + "version": "1.0.0", "description": "SMTP to HTTP gateway", "bin": { "smtp2http": "./smtp2http.js"