Umbrel - Installing BoS

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 <yourConnectionCode> --budget <yourBudgetAmount-OPTIONAL> > /dev/null &

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.

TMUX Installation

TMUX To use tmux, you can do the following:

sudo apt-get install tmux

tmux new -s <give any session name>

The session name can be anything you like to name. e.g. "my_telegram_bot"

then in that window bos telegram --connect <connect id> where connect_id is your connection id - numeric key received from bot.

at this point, your bot should be working

to detach from TMUX, now enter ctrl+b d note ctrl-b is one command followed by d (not ctrl-b d together)

It should say detached from the session

If you want to connect back to this session later, just ssh again and then tmux ls and you should see your session you can then use tmux attach -t <YourSessionNameHere> you can keep attaching and detaching from the session and it keeps running

tmux kill-server —— to kill the sessions tmux attach -t <session name>

Paying invoices from bot

If you have secure access to your telegram account and you want to allow the Telegram Bot to pay invoices set a budget to pay for invoices through telegram using bot's /pay command:

bos telegram —-connect <numeric key from telegram bot> —-budget <yourMaxBudget in sats>

If you prefer to use bot only for messages from your node, do not set budget and it wont be able to pay any invoices.