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):

These instructions are from bos installation instructions.

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

sudo apt-get install -y nodejs

Avoid using sudo with NPM

mkdir ~/.npm-global

npm config set prefix '~/.npm-global'

Update path

nano ~/.profile

Add line to the end

PATH="$HOME/.npm-global/bin:$PATH"

Save and exit ctrl + x
y enter

update shell:

. ~/.profile

Install balanceofsatoshis. This command also works for upgrade

npm i -g balanceofsatoshis

Step 3: Validate that the tool is working:

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

bos --version
bos utxos

If you get a 503, UnexpectedgetUtxosError, do the following:

sudo nano /etc/hosts
add the following line at the bottom

127.0.0.1 umbrel.local

Then save and exit, ctrl + x
y enter
Now test again

Step 4: 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
BotFather will give you a link to your new bot, click on it and it will take you to your bot.
Now come back to your node
On your SSH session run: 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
bos telegram command needs to be running in the background for the bot to be online always, you can keep the bot online with either Docker or TMUX. If you prefer not to install docker or tmux option, see the disown/nohup section at the end.

Docker Instructions:

Run: docker pull alexbosworth/balanceofsatoshis

This is the UMBREL SPECIFIC docker command string to run the telegram bot:
10.21.21.9, this is a sample LND_IP. To get your own LND_IP address to use in the docker command, run:
cat /home/umbrel/.env
and replace the IP you get in the below command.
docker run -d --restart always --network="host" --add-host=umbrel.local:10.21.21.9 -v $HOME/.bos:/home/node/.bos -v $HOME/umbrel/lnd:/home/node/.lnd:ro alexbosworth/balanceofsatoshis:latest telegram --connect <YOUR CONNECT CODE HERE>

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>

nohup or disown

if you are not using docker or tmux and want a simpler unix way or running the process in background after you exit the shell you can use disown or nohup.

bos telegram --connect <yourConnectionCode> 1> /tmp/bos.log 2>&1 & disown OR nohup bos telegram --connect <yourConnectionCode> 1> /tmp/bos.log 2>&1 &

both command will execute the process in background and you will get the process id as

$ /usr/bin/bos telegram --connect XXXXXX 1>/tmp/bos.log 2>&1 & disown

[1] 26912 <---- this process ID will be different for each session.

when you are running under nohup, exit your shell by typing exit on your shell prompt and do not just press x on there terminal window to close the window. Closing terminal window sends SIGTERM to terminated the running processes under the shell instead of SIGHUP.

disown is preferred, some plebs have reported issues with nohup that the process exits after they exit from shell (possibly by closing the window instead of pressing exit).

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.