twisterarmy
/
twister-seeder
mirror of https://github.com/twisterarmy/twister-seeder.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Merge pull request #4 from slr/tasty-readme 

add some shine for README
pull/1/head
miguelfreitas 10 years ago
parent
ea7d27a85b f1b2f13526
commit
dee536a216
1 changed files with 19 additions and 10 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 27
      README.md

27
README → README.md
Unescape View File

@ -1,8 +1,11 @@
bitcoin-seeder Twister-seeder
============== ==============
Bitcoin-seeder is a crawler for the Bitcoin network, which exposes a list Twister-seeder is a crawler for the [Twister](http://twister.net.co)
of reliable nodes via a built-in DNS server. ([github](https://github.com/miguelfreitas/twister-core)) network,
which exposes a list of reliable nodes via a built-in DNS server.
Code based on [Bitcoin-seeder](https://github.com/sipa/bitcoin-seeder).
Features: Features:
* regularly revisits known nodes to check their availability * regularly revisits known nodes to check their availability
@ -12,26 +15,32 @@ Features:
* 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 96 threads simultaneously).
USAGE USAGE
----- -----
Using of it is [highly appreciated](http://twister.net.co/?p=410). If you
have a 24×7 machine and you are able to add an special NS record to your domain,
please consider running twister-seeder. Then let @miguelfreitas know
and he will add your domain to the code base.
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 authorative NS record in example.com's domain record, pointing need an authorative 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
As answer you should get something like this:
;; 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:
./dnsseed -h dnsseed.example.com -n vps.example.com ./dnsseed -h dnsseed.example.com -n 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-mailadres (with the @ part replaced by .) using -m. e-mailadres (with the @ part replaced by .) using `-m`.
RUNNING AS NON-ROOT RUNNING AS NON-ROOT
------------------- -------------------
@ -41,7 +50,7 @@ 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 -p 5353 option. the -p 5353 option.
Write Preview
Loading…
Cancel
Save