From f767baa3f2ee0ec0eaeeb64792830033862095b3 Mon Sep 17 00:00:00 2001 From: Adam Cooke Date: Sun, 17 Mar 2024 17:37:44 +0000 Subject: [PATCH] docs: update readme --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 31c0e9f..e0a0dee 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,24 @@ This is a very simple web & SMTP server which will response to all requests sent ## Usage +Start the server with the following: + ``` -blackhole +docker run --pull always \ + -p 80:8080 \ + -p 25:2525 \ + ghcr.io/postalserver/blackhole:latest ``` + +### SMTP + +You can send email to `accept@anydomain.com` which will be accepted. Any other username will be blocked at the `RCPT TO` stage. + +### HTTP + +The following URLs are available. + +* `/200` - returns a 200 OK +* `/403` - returns a 403 Forbidden +* `/500` - returns a 500 Internal Server Error +* All other URLs will return a 404 Not Found