diff --git a/README.md b/README.md index 5f2e924c..72ded427 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ dcrseeder is a crawler for the Decred network, which exposes a list of reliable nodes via a built-in HTTP server. When dcrseeder is started for the first time, it will connect to the dcrd node -specified with the `-s` flag, send a `getaddrs` request, expecting an `addr` +specified in config, send a `getaddrs` request, expecting an `addr` message response. This message contains hostnames and IPs of peers known by the node. dcrseeder will then connect to each of these peers, send a `getaddrs` request, and will continue traversing the network in this fashion. dcrseeder maintains a list of all known peers and periodically checks that they are online and available. The list is stored on disk in a json file, so on -subsequent start ups the dcrd node specified with `-s` does not need to be +subsequent start ups the dcrd node specified in config does not need to be online. When dcrseeder is queried for node information, it responds with details of a @@ -33,11 +33,13 @@ root directory. To start dcrseeder listening on localhost:8000 with an initial connection to working testnet node 192.168.0.1: ```no-highlight -$ ./dcrseeder -s 192.168.0.1 --testnet --httplisten=localhost:8000 +$ ./dcrseeder --testnet.enabled --testnet.seeder 192.168.0.1 --testnet.listen=localhost:8000 ``` You will then need to redirect HTTPS traffic on your public IP to localhost:8000 +An [example configuration file](./sample-dcrseeder.conf) lists the full set of options available. + ## Issue Tracker The [integrated github issue tracker](https://github.com/decred/dcrseeder/issues)