Go to file
Peter Todd bc43d4cbfb
Add .gitignore
2013-10-12 15:39:31 -04:00
.gitignore Add .gitignore 2013-10-12 15:39:31 -04:00
Makefile Use more standard CXXFLAGS 2013-04-28 03:22:56 +02:00
README help text 2012-01-01 23:23:21 +01:00
bitcoin.cpp RequireHeight differs for mainnet and testnet 2013-08-09 11:25:54 +04:00
bitcoin.h Only poll nodes once a week for new addresses 2013-04-25 01:55:26 +02:00
combine.pl Better combination formula 2012-04-18 02:12:21 +02:00
compat.h Add missing files 2012-05-25 15:43:37 +02:00
db.cpp Only poll nodes once a week for new addresses 2013-04-25 01:55:26 +02:00
db.h RequireHeight differs for mainnet and testnet 2013-08-09 11:25:54 +04:00
dns.c Bugfix: case-insensitive hostname matching 2013-07-15 12:20:36 +02:00
dns.h IPv6/AAAA record support 2012-05-25 15:41:27 +02:00
main.cpp Crawler thread should know amount of threads for correct sleep 2013-08-09 12:28:52 +04:00
netbase.cpp Updated netbase from upstream bitcoin 2012-09-29 18:10:17 +02:00
netbase.h Updated netbase from upstream bitcoin 2012-09-29 18:10:17 +02:00
protocol.cpp IPv6/AAAA record support 2012-05-25 15:41:27 +02:00
protocol.h IPv6/AAAA record support 2012-05-25 15:41:27 +02:00
serialize.h working 2011-12-20 05:20:50 +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 working 2011-12-20 05:20:50 +01: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

README

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).

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-mailadres (with the @ part replaced by .) using -m.

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.