Go to file
Pieter Wuille 00542a6800
Merge #77: [doc] add hex equivalent for flags
f81b533bb5 [doc] add hex equivalent for flags (Sjors Provoost)

Pull request description:

  Handy for those who do not natively think in binary and hex.

ACKs for top commit:
  sipa:
    ACK f81b533bb5

Tree-SHA512: 92ec7604d5a302fabfa68e72c250ea6f69e8715d50b9724cf9af6eb88beff7837d898b60ff1d5b663f473f5e3d6fed41067fb803ec2dffe31c63171d8afa1357
2020-12-17 11:04:31 -08:00
.gitignore Add .gitignore 2013-10-12 15:39:31 -04:00
bitcoin.cpp Use distinct read and except sets in select() 2020-10-09 19:44:29 -07:00
bitcoin.h Overwrite db services with version message results 2020-10-09 19:37:28 -07:00
combine.pl Better combination formula 2012-04-18 02:12:21 +02:00
compat.h removed redundant insert and added a missing define on mac os x 2014-03-24 22:17:43 +01:00
db.cpp Don't merge in re-rumours' nServices 2020-10-10 10:20:26 -07:00
db.h Overwrite db services with version message results 2020-10-09 19:37:28 -07:00
dns.cpp Merge #84: Add --address, bind to specific address 2020-12-17 10:58:03 -08:00
dns.h Add --address, bind to specific address 2020-08-06 03:29:56 +02:00
main.cpp Merge #77: [doc] add hex equivalent for flags 2020-12-17 11:04:31 -08:00
Makefile Convert dns.c to C++ 2019-12-02 15:16:26 -08:00
netbase.cpp Merge pull request #19 2015-07-29 15:55:49 +02:00
netbase.h Merge pull request #19 2015-07-29 15:55:49 +02:00
protocol.cpp Avoid strncpy for commands 2020-10-09 19:51:19 -07:00
protocol.h Add support for NODE_COMPACT_FILTERS by default 2019-08-09 17:04:12 -07:00
README Add setcap hint to readme 2020-12-16 20:25:09 +01:00
serialize.h removed redundant insert and added a missing define on mac os x 2014-03-24 22:17:43 +01:00
strlcpy.h Add missing files 2012-05-25 15:43:37 +02:00
test.pl IPv6/AAAA record support 2012-05-25 15:41:27 +02:00
uint256.h Delete unused TestUint256AdHoc 2019-08-09 16:53:30 -07:00
util.cpp Add missing files 2012-05-25 15:43:37 +02:00
util.h fix logging 2012-05-25 16:03:10 +02:00

bitcoin-seeder
==============

Bitcoin-seeder is a crawler for the Bitcoin network, which exposes a list
of reliable nodes via a built-in DNS server.

Features:
* regularly revisits known nodes to check their availability
* bans nodes after enough failures, or bad behaviour
* accepts nodes down to v0.3.19 to request new IP addresses from,
  but only reports good post-v0.3.24 nodes.
* keeps statistics over (exponential) windows of 2 hours, 8 hours,
  1 day and 1 week, to base decisions on.
* very low memory (a few tens of megabytes) and cpu requirements.
* crawlers run in parallel (by default 24 threads simultaneously).

REQUIREMENTS
------------

$ sudo apt-get install build-essential libboost-all-dev libssl-dev

USAGE
-----

Assuming you want to run a dns seed on dnsseed.example.com, you will
need an authorative NS record in example.com's domain record, pointing
to for example vps.example.com:

$ dig -t NS dnsseed.example.com

;; ANSWER SECTION
dnsseed.example.com.   86400    IN      NS     vps.example.com.

On the system vps.example.com, you can now run dnsseed:

./dnsseed -h dnsseed.example.com -n vps.example.com

If you want the DNS server to report SOA records, please provide an
e-mail address (with the @ part replaced by .) using -m.

COMPILING
---------
Compiling will require boost and ssl.  On debian systems, these are provided
by `libboost-dev` and `libssl-dev` respectively.

$ make

This will produce the `dnsseed` binary.


RUNNING AS NON-ROOT
-------------------

Typically, you'll need root privileges to listen to port 53 (name service).

One solution is using an iptables rule (Linux only) to redirect it to
a non-privileged port:

$ iptables -t nat -A PREROUTING -p udp --dport 53 -j REDIRECT --to-port 5353

If properly configured, this will allow you to run dnsseed in userspace, using
the -p 5353 option.

Another solution is allowing a binary to bind to ports < 1024 with setcap (IPv6 access-safe)

$ setcap 'cap_net_bind_service=+ep' /path/to/dnsseed