From 69f8fe9d147a05483841bcc4543eaf9a6e2567a2 Mon Sep 17 00:00:00 2001 From: Mik-TF Date: Mon, 10 Jun 2024 11:23:32 -0400 Subject: [PATCH 1/3] added node status bot guide --- src/SUMMARY.md | 1 + src/documentation/farmers/farmers.md | 1 + .../node_status_bot/node_status_bot.md | 115 ++++++++++++++++++ 3 files changed, 117 insertions(+) create mode 100644 src/documentation/farmers/node_status_bot/node_status_bot.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 13731ff3..823d713a 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -184,6 +184,7 @@ - [Quick Guide](documentation/farmers/farmerbot/farmerbot_quick.md) - [Additional Information](documentation/farmers/farmerbot/farmerbot_information.md) - [Minting and the Farmerbot](documentation/farmers/farmerbot/farmerbot_minting.md) + - [Node Status Bot](documentation/farmers/node_status_bot/node_status_bot.md) - [Farming Troubleshooting](documentation/farmers/farming_troubleshooting.md) - [System Administrators](documentation/system_administrators/system_administrators.md) - [Getting Started](documentation/system_administrators/getstarted/tfgrid3_getstarted.md) diff --git a/src/documentation/farmers/farmers.md b/src/documentation/farmers/farmers.md index 5e6d46e6..9f9c2eaa 100644 --- a/src/documentation/farmers/farmers.md +++ b/src/documentation/farmers/farmers.md @@ -32,6 +32,7 @@ To buy a certified node from an official ThreeFold vendor, check the [ThreeFold - [Quick Guide](./farmerbot/farmerbot_quick.md) - [Additional Information](./farmerbot/farmerbot_information.md) - [Minting and the Farmerbot](./farmerbot/farmerbot_minting.md) +- [Node Status Bot](./node_status_bot/node_status_bot.md) - [Farming Troubleshooting](./farming_troubleshooting.md) - [Farmers FAQ](../faq/faq.md#farmers-faq) diff --git a/src/documentation/farmers/node_status_bot/node_status_bot.md b/src/documentation/farmers/node_status_bot/node_status_bot.md new file mode 100644 index 00000000..3a39001f --- /dev/null +++ b/src/documentation/farmers/node_status_bot/node_status_bot.md @@ -0,0 +1,115 @@ +

Node Status Bot

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Disclaimer](#disclaimer) +- [Set the Bot](#set-the-bot) +- [Commands](#commands) +- [Bugs and Features](#bugs-and-features) +- [Node Status Bot News](#node-status-bot-news) + +--- + +## Introduction + +We present the [Node Status Bot](https://t.me/tfnodestatusbot) and how to use it. + +The Node Status Bot is a very helpful tool for farmers of the ThreeFold Grid. It can give you relevant information on your node status, notify you if the node status changes and also provide information on minting violations. + +You can find the bot source code on GitHub [here](https://github.com/threefoldfoundation/node-status-bot). + +## Disclaimer + +Note that the bot is developed and operated on a best effort basis. You are responsible for your nodes' uptime and your farming rewards. + +## Set the Bot + +To set the bot, simply go to the [bot link on Telegram](https://t.me/tfnodestatusbot) and subscribe your nodes to the bot (e.g. with nodes 1, 2 and 3). + +``` +/sub 1 2 3 +``` + +By default, the bot is on main network. To change the network, e.g. dev or test networks, use the following command before subscribing your nodes: + +``` +/net dev +``` + +You can quickly check your nodes' status with the following command: + +``` +/status +``` + +You can also check if there are any violations in the current minting period: + +``` +/violations +``` + +The next section covers in-depth the different commands available. + +## Commands + +The bot supports the following commands: + +- `/help` + - Print the start message with all the available commands +- `/status` + - Check the current status of one or all nodes. + - This uses a similar method as the Dashboard for determining node status, and update may be delayed by an hour + - With no input, a status report will be generated for all subscribed nodes, if any + - Examples + - Check status of node ID 1 + - `/status 1` + - Check status of all currently subscribed nodes + - `/status` +- `/violations` + - Scan for farmerbot related violations during the current and previous minting periods + - Like status, this works on all subscribed nodes when no input is given + - Examples + - Check violations of node ID 1 + - `/violations 1` + - Check status of all currently subscribed nodes + - `/violations` +- `/subscribe` + - Subscribe to updates about one or more nodes + - You can use the shortcut `/sub` + - If you don't provide an input, the nodes you are currently subscribed to will be shown + - Examples + - Subscribe to node ID 1 + - `/sub 1` + - Subscribe to node ID 1, 2, 3 + - `/sub 1 2 3` + - Check all subscribed nodes + - `/sub` +- `/unsubscribe` + - Unsubscribe to updates about one or more nodes + - You can use the shortcut `/unsub` + - Examples + - Unsubscribe to node ID 1 + - `/unsubscribe 1` + - Unsubscribe to node ID 1, 2, 3 + - `/unsubscribe 1 2 3` + - Unsubscribe to all currently subscribed nodes + - `/unsub all` +- `/network` + - Change the network to `dev`, `test`, or `main` + - Default is `main` + - You can use the shortcut `/net` + - If you don't provide an input, the currently selected network is shown + - Examples + - Check current network + - `/network` + - Change to another network, e.g. to `dev` + - `/net dev` + +## Bugs and Features + +To report bugs and request features, please contact [Scott Yeager on Telegram](https://t.me/scottyeager). + +## Node Status Bot News + +You can subscribe to the [Node Status Bot News channel](https://t.me/node_bot_updates) on Telegram to receive updates and news concerning the bot. From 1e2b2bd8b4b64a58b48939a242bb43bef4c2da72 Mon Sep 17 00:00:00 2001 From: Scott Yeager Date: Tue, 11 Jun 2024 15:40:59 -0700 Subject: [PATCH 2/3] Update bot guide --- .../node_status_bot/node_status_bot.md | 28 ++++++++++++------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/src/documentation/farmers/node_status_bot/node_status_bot.md b/src/documentation/farmers/node_status_bot/node_status_bot.md index 3a39001f..6983791c 100644 --- a/src/documentation/farmers/node_status_bot/node_status_bot.md +++ b/src/documentation/farmers/node_status_bot/node_status_bot.md @@ -23,27 +23,35 @@ You can find the bot source code on GitHub [here](https://github.com/threefoldfo Note that the bot is developed and operated on a best effort basis. You are responsible for your nodes' uptime and your farming rewards. -## Set the Bot +## Getting Started with the Bot -To set the bot, simply go to the [bot link on Telegram](https://t.me/tfnodestatusbot) and subscribe your nodes to the bot (e.g. with nodes 1, 2 and 3). +To get started with the bot, simply go to the [bot link on Telegram](https://t.me/tfnodestatusbot) and hit the start button to begin interacting with the bot. + +You can get the real time status of a node with the status command. For example, this gives the status of node 42 ``` -/sub 1 2 3 +/status 42 ``` -By default, the bot is on main network. To change the network, e.g. dev or test networks, use the following command before subscribing your nodes: +The bot can also send you a message when the status of a node changes. Use the subscribe command (or sub for short) to begin alerts for one or more nodes. Here we are subscribing to nodes 1, 2, and 3: ``` -/net dev +/sub 1 2 3 ``` -You can quickly check your nodes' status with the following command: +Once you have subscribed you can issue the status command with no input to get the current status of the nodes you are subscribed to: ``` /status ``` -You can also check if there are any violations in the current minting period: +By default, the bot is on main network. To change the network to the dev or test networks, use the network (net) command. Changing the network does not affect any existing subscriptions, and the bot does not specify which network the nodes belong to in its messages. Here's an example to change the network to devnet: + +``` +/net dev +``` + +You can also check if there are any violations in the current minting period. Like status, this command takes a node id as input or works on the currently subscribed nodes if no input is given: ``` /violations @@ -53,7 +61,7 @@ The next section covers in-depth the different commands available. ## Commands -The bot supports the following commands: +Here is a reference for all supported commands and their different forms: - `/help` - Print the start message with all the available commands @@ -108,8 +116,8 @@ The bot supports the following commands: ## Bugs and Features -To report bugs and request features, please contact [Scott Yeager on Telegram](https://t.me/scottyeager). +To report bugs and request features, please open an issue on the [GitHub repo](https://github.com/threefoldfoundation/node-status-bot) contact [Scott Yeager on Telegram](https://t.me/scottyeager). ## Node Status Bot News -You can subscribe to the [Node Status Bot News channel](https://t.me/node_bot_updates) on Telegram to receive updates and news concerning the bot. +If you use the bot, please also subscribe to the [Node Status Bot News channel](https://t.me/node_bot_updates) on Telegram to receive very occasional updates and news concerning the bot. From 9388e894e44ddc1ed2961ecdb175a3ff8112d945 Mon Sep 17 00:00:00 2001 From: Mik-TF Date: Tue, 11 Jun 2024 20:12:52 -0400 Subject: [PATCH 3/3] added or in a sentence --- .../farmers/node_status_bot/node_status_bot.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/documentation/farmers/node_status_bot/node_status_bot.md b/src/documentation/farmers/node_status_bot/node_status_bot.md index 6983791c..29bcc01b 100644 --- a/src/documentation/farmers/node_status_bot/node_status_bot.md +++ b/src/documentation/farmers/node_status_bot/node_status_bot.md @@ -4,7 +4,7 @@ - [Introduction](#introduction) - [Disclaimer](#disclaimer) -- [Set the Bot](#set-the-bot) +- [Getting Started with the Bot](#getting-started-with-the-bot) - [Commands](#commands) - [Bugs and Features](#bugs-and-features) - [Node Status Bot News](#node-status-bot-news) @@ -116,8 +116,8 @@ Here is a reference for all supported commands and their different forms: ## Bugs and Features -To report bugs and request features, please open an issue on the [GitHub repo](https://github.com/threefoldfoundation/node-status-bot) contact [Scott Yeager on Telegram](https://t.me/scottyeager). +To report bugs and request features, please open an issue on the [GitHub repo](https://github.com/threefoldfoundation/node-status-bot) or contact [Scott Yeager on Telegram](https://t.me/scottyeager). ## Node Status Bot News -If you use the bot, please also subscribe to the [Node Status Bot News channel](https://t.me/node_bot_updates) on Telegram to receive very occasional updates and news concerning the bot. +If you use the bot, please also subscribe to the [Node Status Bot News channel](https://t.me/node_bot_updates) on Telegram to receive occasional updates and news concerning the bot.