Skip to content
/ Nodi Public

Nodi is a Telegram bot for monitoring and Logging your Bitcoin Full-Node.

Notifications You must be signed in to change notification settings

d4niee/Nodi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🤖 Nodi (⚠️ currently in development!)

Nodi is a Telegram bot for monitoring and Logging your Bitcoin Full-Node and LND. The Bot was designed to be used with the Raspi Blitz Project (see here)

🛠️ Preparation

Before you can start using Nodi you have to create your own Telegram bot. Because you want to use it for your own node there is no option for a global usable Bot (But It's free and simple! 🎉). Also you need to install nodejs in the System you want to run the bot (Raspi Blitz for example).

create your own bot using the botfather

The following steps describe how to create a new bot that you can use Nodi

  • Contact @BotFather in your Telegram messenger
  • To get a token, send BotFather a message that says /newbot
  • When asked for a name for your new bot choose something that ends with the word bot. For example, my_test_bot
  • If your chosen name is available, BotFather will send you a token
  • Save the token for later

install nodejs

If you run the Bot on your Raspberry Pi with Raspi Blitz Nodejs should be pre installed with the enhanced Image. But if not, or you are using the minimal installation you can install Nodejs with following command. This will install the current LTS version of Nodejs

sudo apt update
sudo apt install nodejs

add your bot to the environment file

Now you have the token for your bot from step one the botfather. In the root directory create a new file .env and paste following content into it:

BOT_TOKEN="YOUR TOKEN HERE"

You need this token to communicate with the Bot later

🔧 Installation

First you need to clone the Repository and install all required dependencies

git clone https://github.com/d4niee/Nodi.git
cd Nodi
npm install

Running Nodi

Now you can run the Bot

node index.js

📜 Commands

Category Command Description
Utility uptime Displays the system uptime.

References

  1. RaspiBlitz - RaspiBlitz
  2. Telegram Bot API Documentation - Telegram Bot API
  3. Node Telegram Bot API - Node Telegram Bot API
  4. Node Telegram Bot API Tutorial - Node Telegram Bot API Tutorial by hosein2398

About

Nodi is a Telegram bot for monitoring and Logging your Bitcoin Full-Node.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published