Difference between revisions of "Bootstrap Downloader"
VeriBlockTim (talk | contribs) (Created page with "See: NodeCore_0.4.8_ReleaseNotes == Overview == The bootstrap-downloader is a new tool which can be used to download all block files, or missing block files, and an updat...") |
VeriBlockTim (talk | contribs) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
See: [[NodeCore_0.4.8_ReleaseNotes]] | See: [[NodeCore_0.4.8_ReleaseNotes]] | ||
| + | |||
| + | __TOC__ | ||
== Overview == | == Overview == | ||
The bootstrap-downloader is a new tool which can be used to download all block files, or missing block files, and an updated nodecore.dat from the VeriBlock mirrors, so that you can sync a full node much quicker than from peers. When doing an incremental update, it checks all existing block files for corruption and will replace them along with downloading any missing (newer) files that you may not have. | The bootstrap-downloader is a new tool which can be used to download all block files, or missing block files, and an updated nodecore.dat from the VeriBlock mirrors, so that you can sync a full node much quicker than from peers. When doing an incremental update, it checks all existing block files for corruption and will replace them along with downloading any missing (newer) files that you may not have. | ||
| + | |||
| + | Source code here: https://github.com/VeriBlock/nodecore/tree/master/bootstrap-downloader | ||
== Usage == | == Usage == | ||
| + | The bootstrap-downloader can be started with the '''bootstrap-downloader.bat''' (windows) and '''bootstrap-downloader''' (linux/mac). | ||
| + | |||
| + | By default, the bootstrap-downloader will download the '''mainnet''' block files inside the '''nodecore/bin''' folder from the '''distributed package'''. | ||
| + | |||
| + | If for any reason the '''nodecore/bin''' folder from the distributed package can't be located (e.g: you call the start script from another folder) the data blocks will be downloaded at '''./''' | ||
| + | |||
| + | Please remember, the usage of the bootstrap-downloader '''is optional''' and is not necessary to run a NodeCore instance, also it is not intended to be the main way to maintain your NodeCore installation. | ||
| + | |||
| + | Note: The bootstrap-downloader will update the files which are on the target data directory (including the nodecore.dat file) so please, '''stop any NodeCore instance using the targeted data directory before its use'''. | ||
| + | |||
| + | === Program Options === | ||
The following program options are available: | The following program options are available: | ||
| − | |||
| − | |||
| + | {|class="wikitable" | ||
| + | |+Program Options | ||
| + | |- | ||
| + | |Option | ||
| + | |Description | ||
| + | |Example | ||
| + | |- | ||
| + | | -n | ||
| + | |Specify the target network | ||
| + | | -n testnet | ||
| + | |- | ||
| + | | -d | ||
| + | |Specify the target data directory | ||
| + | | -d /nodecore_data | ||
| + | |- | ||
| + | |} | ||
| + | === Usage Examples === | ||
| + | * To download the '''testnet''' blocks inside the '''nodecore/bin''' folder from the '''distributed package''': <code>bootstrap-downloader.bat -n testnet</code> | ||
| + | * To download the '''testnet''' blocks inside a '''custom data folder''': <code>bootstrap-downloader.bat -n testnet -d route_to_data_folder</code> | ||
| + | * To download the '''mainnet''' blocks inside a '''custom data folder''': <code>bootstrap-downloader.bat -d route_to_data_folder</code> | ||
| + | |||
| + | === Environment Variables === | ||
The following environment variables are available: | The following environment variables are available: | ||
| − | |||
| + | {|class="wikitable" | ||
| + | |+Environment variables | ||
| + | |- | ||
| + | |Name | ||
| + | |Description | ||
| + | |Example | ||
| + | |- | ||
| + | | DOWNLOADER_LOG_LEVEL | ||
| + | |Specify log level for the application | ||
| + | | DOWNLOADER_LOG_LEVEL=DEBUG | ||
| + | |- | ||
| + | |} | ||
| − | + | == TestNet == | |
| − | + | See: [[TestNet#Bootstrap]] | |
== Expected console output == | == Expected console output == | ||
Revision as of 02:27, 21 October 2020
See: NodeCore_0.4.8_ReleaseNotes
Contents
Overview
The bootstrap-downloader is a new tool which can be used to download all block files, or missing block files, and an updated nodecore.dat from the VeriBlock mirrors, so that you can sync a full node much quicker than from peers. When doing an incremental update, it checks all existing block files for corruption and will replace them along with downloading any missing (newer) files that you may not have.
Source code here: https://github.com/VeriBlock/nodecore/tree/master/bootstrap-downloader
Usage
The bootstrap-downloader can be started with the bootstrap-downloader.bat (windows) and bootstrap-downloader (linux/mac).
By default, the bootstrap-downloader will download the mainnet block files inside the nodecore/bin folder from the distributed package.
If for any reason the nodecore/bin folder from the distributed package can't be located (e.g: you call the start script from another folder) the data blocks will be downloaded at ./
Please remember, the usage of the bootstrap-downloader is optional and is not necessary to run a NodeCore instance, also it is not intended to be the main way to maintain your NodeCore installation.
Note: The bootstrap-downloader will update the files which are on the target data directory (including the nodecore.dat file) so please, stop any NodeCore instance using the targeted data directory before its use.
Program Options
The following program options are available:
| Option | Description | Example |
| -n | Specify the target network | -n testnet |
| -d | Specify the target data directory | -d /nodecore_data |
Usage Examples
- To download the testnet blocks inside the nodecore/bin folder from the distributed package:
bootstrap-downloader.bat -n testnet - To download the testnet blocks inside a custom data folder:
bootstrap-downloader.bat -n testnet -d route_to_data_folder - To download the mainnet blocks inside a custom data folder:
bootstrap-downloader.bat -d route_to_data_folder
Environment Variables
The following environment variables are available:
| Name | Description | Example |
| DOWNLOADER_LOG_LEVEL | Specify log level for the application | DOWNLOADER_LOG_LEVEL=DEBUG |
TestNet
See: TestNet#Bootstrap
Expected console output
At the start, the downloader will check how many files are available on the trusted host, after that, the local files are checked (this operation may take several minutes if it's ran over an existing data folder, the speed will depend on your disk), as the last step, the tool will download all the necessary files individually.
