Changeset View
Changeset View
Standalone View
Standalone View
src/seeder/README.md
Show All 11 Lines | |||||
* keeps statistics over (exponential) windows of 2 hours, 8 hours, | * keeps statistics over (exponential) windows of 2 hours, 8 hours, | ||||
1 day and 1 week, to base decisions on. | 1 day and 1 week, to base decisions on. | ||||
* very low memory (a few tens of megabytes) and cpu requirements. | * very low memory (a few tens of megabytes) and cpu requirements. | ||||
* crawlers run in parallel (by default 24 threads simultaneously). | * crawlers run in parallel (by default 24 threads simultaneously). | ||||
REQUIREMENTS | REQUIREMENTS | ||||
------------ | ------------ | ||||
$ sudo apt-get install build-essential libboost-all-dev libssl-dev | sudo apt-get install build-essential libboost-all-dev libssl-dev | ||||
USAGE | USAGE | ||||
----- | ----- | ||||
Assuming you want to run a dns seed on dnsseed.example.com, you will | Assuming you want to run a dns seed on dnsseed.example.com, you will | ||||
need an authoritative NS record in example.com's domain record, pointing | need an authoritative NS record in example.com's domain record, pointing | ||||
to for example vps.example.com: | to for example vps.example.com: | ||||
$ dig -t NS dnsseed.example.com | dig -t NS dnsseed.example.com | ||||
;; ANSWER SECTION | ;; ANSWER SECTION | ||||
dnsseed.example.com. 86400 IN NS vps.example.com. | dnsseed.example.com. 86400 IN NS vps.example.com. | ||||
On the system vps.example.com, you can now run dnsseed: | On the system vps.example.com, you can now run dnsseed: | ||||
./bitcoin-seeder -host=dnsseed.example.com -ns=vps.example.com | ./bitcoin-seeder -host=dnsseed.example.com -ns=vps.example.com | ||||
If you want the DNS server to report SOA records, please provide an | If you want the DNS server to report SOA records, please provide an | ||||
e-mail address (with the @ part replaced by .) using -mbox. | e-mail address (with the `@` part replaced by `.`) using `-mbox`. | ||||
RUNNING AS NON-ROOT | RUNNING AS NON-ROOT | ||||
------------------- | ------------------- | ||||
Typically, you'll need root privileges to listen to port 53 (name service). | 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 | One solution is using an iptables rule (Linux only) to redirect it to | ||||
a non-privileged port: | a non-privileged port: | ||||
$ iptables -t nat -A PREROUTING -p udp --dport 53 -j REDIRECT --to-port 5353 | 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 | If properly configured, this will allow you to run dnsseed in userspace, using | ||||
the -port=5353 option. | the `-port=5353` option. | ||||
Generate Seed Lists | Generate Seed Lists | ||||
------------------- | ------------------- | ||||
Bitcoin-seeder is also be used to generate the seed lists that are compiled | Bitcoin-seeder is also be used to generate the seed lists that are compiled | ||||
into every Bitcoin ABC release. It produces the `dnsseed.dump` files that are | into every Bitcoin ABC release. It produces the `dnsseed.dump` files that are | ||||
used as inputs to the scripts in [contrib/seeds](/contrib/seeds) to generate | used as inputs to the scripts in [contrib/seeds](/contrib/seeds) to generate | ||||
the seed lists. To generate seed lists, the seeder should be run continuously | the seed lists. To generate seed lists, the seeder should be run continuously | ||||
for 30 days or more. | for 30 days or more. | ||||