Umbrel - Installing BoS

From PlebNet Wiki
Revision as of 18:50, 12 August 2021 by Itsneski (talk | contribs)
Jump to navigation Jump to search

Installing BOS

These are the commands to enter in a command-line interface for Umbrel - (once you have ssh'd into your umbrel, you can follow these steps):


Step 1: Install npm

sudo apt install npm


Step 2: Install Balance of Satoshis

sudo npm install -g balanceofsatoshis

sudo apt update

curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash -

sudo apt-get install -y nodejs

mkdir -p .bos/umbrel/

cd .bos/umbrel


Step 3: Create the credentials file:

sudo nano credentials.json

and paste the following inside:

{ "cert_path": "/home/umbrel/umbrel/lnd/tls.cert",

"macaroon_path": "/home/umbrel/umbrel/lnd/data/chain/bitcoin/mainnet/admin.macaroon",

"socket": "localhost:10009" }

Step 4: Validate that the tool is working:

Run the following commands and validate the output (not an error):

bos --version
bos utxos

Step 5: Installing Telegram Bot

Go to Telegram Start chat with @BotFather press /start /newbot Decide A bot name NodeAliasNew Decide a bot user name for telegram BotName_bot

You will get a long alphanumeric API KEY for the bot, Note that. You can always retrieve it using /mybot with BotFather Now you will be at a connect key prompt. Go to next step before pressing anything.

Now come back to your node

On your SSH session bos telegram at first prompt type API key (alpha numeric) received from BotFather

In telegram go to your bot (link in BotFather window usually @BotName_bot

type /connect

you will get a numeric key

type that numeric key on the second prompt in your ssh session with bos telegram

You should get a connected message in your Telegram Bot as well as on SSH session.

Verify by typing /version in your telegram bot and you should see the version number of bos.


Press Ctrl-C in SSH session with bos telegram Now run it as nohup bos telegram --connect <numeric key from telegram bot>

This will run your telegram bot even if you come out of your ssh session.

Instead of nohup you can also run it under TMUX if you are familiar.