Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adamcooke committed Mar 17, 2024
1 parent b213e91 commit f767baa
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `[email protected]` 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

0 comments on commit f767baa

Please sign in to comment.