finalized README, 1.0 'release' version
This commit is contained in:
parent
46ee6fd9d6
commit
d06f2e4b2c
34
README.md
34
README.md
@ -3,6 +3,26 @@ SMTP to HTTP gateway
|
|||||||
|
|
||||||
Usage
|
Usage
|
||||||
-----
|
-----
|
||||||
|
```sh
|
||||||
|
Usage: smtp2http [-v|--verbose] [-s|--silent|-q|--quiet]
|
||||||
|
[-T|--tls=<tls_opt>] ENDPOINT
|
||||||
|
|
||||||
|
-q --quiet Do not log to STDERR
|
||||||
|
-s --silent Alias for --quiet
|
||||||
|
-T --tls=<tls_opt> 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
|
Begin listening for incoming SMTP messages, parse them, and post them to the
|
||||||
specified HTTP endpoint.
|
specified HTTP endpoint.
|
||||||
```sh
|
```sh
|
||||||
@ -41,7 +61,7 @@ npm install -g
|
|||||||
|
|
||||||
Development
|
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
|
communication. Because of this, development can be difficult if trying to
|
||||||
use public mail providers because you must have an internet facing server
|
use public mail providers because you must have an internet facing server
|
||||||
listening on port 25.
|
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
|
`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
|
the port this host will listen on (standard SMTP port), and `2025` is the port
|
||||||
`smtp2http` will listen on.
|
`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
|
||||||
|
```
|
||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "smtp2http",
|
"name": "smtp2http",
|
||||||
"version": "0.0.2",
|
"version": "1.0.0",
|
||||||
"description": "SMTP to HTTP gateway",
|
"description": "SMTP to HTTP gateway",
|
||||||
"bin": {
|
"bin": {
|
||||||
"smtp2http": "./smtp2http.js"
|
"smtp2http": "./smtp2http.js"
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user