Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
users:runningnodes [2015/09/08 03:39]
cmotc
users:runningnodes [2018/02/22 02:32] (current)
nurupo Refresh this article, also refer to the tox-bootstrd's README instead of duplication just a small part of it in here (and almost no one uses SysVinit nowadays anyway)
Line 1: Line 1:
 ===== How to run a Bootstrap Node ===== ===== How to run a Bootstrap Node =====
  
-==== Installation ​====+==== tox-bootstrapd - Tox Bootstrap Daemon (recommended) ​====
  
-Assuming that Toxcore has already been builtcd to <​code>​/$USER/​toxcore/​build</​code>​ and run <​code>​./​DHT_bootstrap ADDRESS PORT KEY</​code>​+Tox Bootstrap Daemonor tox-bootstrapd for short, is a highly configurable Linux/Unix daemon that acts as a bootstrap node.
  
-Change ​//ADDRESS////PORT//, and //KEY// to that of any [[Nodes#​Active Nodes | active DHT node]].+tox-bootstrapd resides in the toxcore repository and is built along with the toxcore as long as you [[https://github.com/TokTok/c-toxcore/blob/master/INSTALL.md|make sure that you have building ​of tox-bootstrapd enabled and all of the dependencies required by tox-bootstrapd]] installed.
  
-=== Daemonized version ===+Once you have built tox-boostrapd,​ you can [[https://​github.com/​TokTok/​c-toxcore/​tree/​master/​other/​bootstrap_daemon|follow the instructions in its README file]] on how to set it up with SysVinit, systemd or Docker, along with sample SysVInit init script, systemd unit file and Docker Dockerfile.
  
-Toxcore also has a daemonized version of the bootstrap node code wish can be used on SystemV init or systemd init systems.+You can also call
  
-You first need to configure tox to build the bootstrap node executable. Run the configure script with <​code>​--enable-daemon</​code>​ as an argument. The tox_bootstrap_daemon executable will be placed in <​code>​build/​.lib</​code>​, so grab a copy from there and place it where you want the daemon to run from.+<​code>​tox-boostrapd ​--help</​code>​
  
-=== Configuring Daemon script ===+to see all available command-line options. Most of the options are set in a config file though.
  
-//Note that the following instructions might be out of date and it's preferable to read the [[https://​github.com/​irungentoo/​toxcore/​tree/​master/​other/​bootstrap_daemon | README.md file]] maintained by the daemon developer.//​+==== DHT_bootstrap - Simple Bootstrap Program ====
  
-Next we need to configure <​code>​other/bootstrap_daemon/​tox_bootstrap_daemon.sh</code>+DHT_bootstrap is a very simple bootstrap program that runs in the foreground. In contrast ​to tox-boostrapd,​ which also can run in the foreground, it provides almost no configuration options but it is not restricted to running on just Linux/Unix, it can run on Windows and pretty much everything else toxcore runs onThus this is a preffered way of running a bootstrap node on a non Linux/Unix system.
  
-Set the //NAME//, //USER//, //CFG//, //​PIDFILE// ​and //​SCRIPTNAME//​ arguments as per your installation. +DHT_bootstrap resides in the toxcore repository ​and is built along with the toxcore as long as you [[https://​github.com/TokTok/c-toxcore/blob/master/​INSTALL.md|make sure that you have building ​of DHT_bootstrap enabled]].
-^Option^Description^ +
-| NAME | Name of the executable (default ​is the tox_bootstrap_daemon) | +
-| USER | Name of the user the daemon will run as (e.g. //tox//| +
-| CFG | Location ​of configuration file | +
-| PIDFILE | Where to create the pid file for the daemon | +
-| SCRIPTNAME | Path to the tox_bootstrap_daemon.sh (used to change name of the script) |+
  
-There are a few other options generated by a combination of these itemsand you may wish to customize them for your needs.+Once built, you can call
  
-=== Configuring the daemon itself ===+<​code>​DHT_bootstrap -h</​code>​
  
-Now we need to configure ​the conf file that the daemon uses, located in <​code>​other/​bootstrap_daemon</​code>​+to see the available options.
  
-At minimum you need to set the //​keys_file_path//​//​pid_file_path// ​and add some bootstrap nodes. +DHT_bootstrap allows bootstrapping off just one other bootstrap nodeaddress, port and key of which you can provide as the first 3 arguments to it.
-^Option^Description^ +
-| keys_file_path | The path to your keys file that will store the keypair for your daemon | +
-| pid_file_path | The path to the pid file and should be set based on what you chose for PIDFILE earlier | +
- +
-To get the bootstrap nodes, ​you can either grab them from [[Nodes#​Active Nodes | here]] or use an updater script - some options here: [[https://​github.com/​irungentoo/​toxcore/​issues/​722| issue]] +
- +
-=== Generate ​the service === +
- +
-Place the daemon script in <​code>/​etc/​init.d</​code>​ and rebuild the service list. +
- +
-Finally, start the service! +
- +
-=== Troubleshooting === +
- +
-The daemon outputs to syslog, so if you have the appropriate permissions:​ +
- +
-<​code>​tail -f /​var/​log/​syslog | grep "​tox_bootstrap_daemon"</​code>​ +
- +
-will give you a nice debug output (NB: if you change the name edit the grep appropriately)+
  
Print/export