brk/crates/brk_cli

BRK Cli

Setup

Hardware

Recommended

• Latest base model Mac mini
• Thunderbolt 4 SSD enclosure
• 2 TB NVMe SSD

Minimum

To be determined

Software

• Unix based operating system (Mac OS or Linux)
  • Ubuntu users need to install open-ssl via sudo apt install libssl-dev pkg-config
• Bitcoin
  • Example: bitcoind -datadir="$HOME/.bitcoin" -blocksonly
• Rust
  • Install: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  • Update: rustup update

Install

cargo install brk_cli

If it's your first time running brk, it will need several information such as:

• --bitcoindir PATH: path to bitcoin core data directory, ???/bitcoin
• --outputdir PATH: path to various outputs, if you have enough space on your main disk ~/.brk is fine

Everything will be saved at ~/.brk/config.toml, which will allow you to simply run brk run next time

If you need more options please run brk -h to see what parameters are available.

Here's an example

brk run --bitcoindir=~/Developer/bitcoin --outputdir=~/.brk

Then the easiest to let others access your server is to use cloudflared which will also cache requests. For more information go to: https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/

Update

cargo install brk_cli

or

cargo install cargo-update
cargo install-update -a