Add a note on CLI options

This commit is contained in:
Mark Poliakov 2024-01-07 04:01:01 +02:00
parent 817e4506a0
commit 62d0d6abbd

View File

@ -7,8 +7,8 @@ The server implements the minimal necessary functionality from
[RFC 8489](https://datatracker.ietf.org/doc/html/rfc8489), namely
the Binding Request.
The server is both IPv6 and IPv4 capable. When listening on IPv6 address,
the server is capable of handling IPv6/IPv4 clients.
The server is both IPv6 and IPv4 capable as well as operating in both TCP/UDP modes.
When listening on IPv6 address, the server is capable of handling IPv6/IPv4 clients.
Running
-------
@ -19,6 +19,14 @@ To try out the server, just run:
$ cargo run
```
By default, the server will receive requests from any network hosts using IPv6,
this can be adjusted by adding a `--no-ipv4` option to disable IPv6 or manually
specifying the `host:port` pair to listen on:
```shell
$ cargo run -- 127.0.0.1:3478
```
Testing
-------