diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..68db103 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# webmaild + +A small SMTP server with a web interface to visualize received emails. + + webmaild -smtp-port 5678 -http-port 8765 + +will start an SMTP and HTTP server locally, ready to accept emails. Go to http://localhost:8765 to view the emails received. + +No authentication is required, but it will happily accept any authentication method and ignore it. + +The default ports, if none are provided, are `5879` for SMTP and `9785` for HTTP. + +Note that this is based on very loose interpretations of the respective RFCs for SMTP, HTTP and emails, and is only intended to help with debugging. I tested with like, 2 emails, and it worked well enough (: + +## Building & Running + +The recommended solution is to use `nix`: + +- Use `nix profile install http://git.k.mulga.net/julien/webmaild/snapshot/webmaild-main.tar.gz` to install webmaild, +- Use `nix run http://git.k.mulga.net/julien/webmaild/snapshot/webmaild-main.tar.gz` to build and run the binary directly. + +If you have `cabal` installed, use `cabal build` or `cabal install`. |