diff --git a/docs/build-with-powerloom/snapshotter-node/lite-node-v2/getting-started.md b/docs/build-with-powerloom/snapshotter-node/lite-node-v2/getting-started.md index 8762845..7688571 100644 --- a/docs/build-with-powerloom/snapshotter-node/lite-node-v2/getting-started.md +++ b/docs/build-with-powerloom/snapshotter-node/lite-node-v2/getting-started.md @@ -190,6 +190,10 @@ After initiating the process, the terminal will prompt you to enter the followin - `$SLOT_ID`: To assign your node to a specific slot, please provide the corresponding Slot ID or NFT ID. You can locate your NFT ID within your transaction details on PolygonScan. +- Optionally, you can provide to following values: + + - `$TELEGRAM_CHAT_ID`: Can be provided if you would like to enable Telegram reporting for node issues. See our [Telegram Bot Setup](/docs/build-with-powerloom/snapshotter-node/lite-node/Telegram%20Bot%20Setup.md) page for instructions on how to get your Telegram Chat ID. + After entering these details, the node will start running the background processes. If you want to exit your screen, type the command in the terminal: diff --git a/docs/build-with-powerloom/snapshotter-node/lite-node-v2/monitoring.md b/docs/build-with-powerloom/snapshotter-node/lite-node-v2/monitoring.md index d83b012..2ea5eac 100644 --- a/docs/build-with-powerloom/snapshotter-node/lite-node-v2/monitoring.md +++ b/docs/build-with-powerloom/snapshotter-node/lite-node-v2/monitoring.md @@ -10,9 +10,13 @@ This section will guide you through the process of Monitoring and Troubleshootin ## Steps to Confirm and Monitor Node Snapshotting Process ### Monitoring Node Activity with the Snapshotter Dashboard -Our Snapshotter Dashboard enables you to verify if your node slot is actively submitting snapshots. + - #### Snapshotter Dashboard + Our Snapshotter Dashboard enables you to verify if your node slot is actively submitting snapshots. -![Snapshotter-node-dashboard](/images/snapshot-lite-v2-daily-dashboard.png) + ![Snapshotter-node-dashboard](/images/snapshot-lite-v2-daily-dashboard.png) + + - #### Telegram Reporting Bot + Snapshotter Lite Nodes have the capability to send Telegram messages directly to you if any issues arise during the snapshotting process. See the [Telegram Bot Setup](/docs/build-with-powerloom/snapshotter-node/lite-node/Telegram%20Bot%20Setup.md) page for instructions on how to enable this feature. ### Terminal Status Check - The primary method to verify node status is through the terminal, which displays log responses from the node. diff --git a/docs/build-with-powerloom/snapshotter-node/lite-node/Telegram Bot Setup.md b/docs/build-with-powerloom/snapshotter-node/lite-node/Telegram Bot Setup.md index c9bcb0b..e71d118 100644 --- a/docs/build-with-powerloom/snapshotter-node/lite-node/Telegram Bot Setup.md +++ b/docs/build-with-powerloom/snapshotter-node/lite-node/Telegram Bot Setup.md @@ -1,36 +1,34 @@ ### Setting up your Telegram Bot | Node Health Monitoring -This guide provides instructions for setting up your Powerloom Telegram Bot to monitor the health of your node. The Snapshotter-lite nodes currently require manual monitoring to detect any issues. +The Snapshotter-lite nodes currently require manual monitoring to detect any issues. -Introducing the Powerloom Telegram Bot, ‘PowerloomReportingBot’. This bot service maintains an internal health state and reports any issues to operators, such as failed or missed snapshots. +Introducing the `PowerloomReportingBot`! This bot service maintains an internal health state and reports any issues to operators, such as failed or missed snapshots. This guide provides instructions for setting up your Powerloom Telegram Bot to monitor the health of your node. -### Follow the steps below to set up your Node Health Monitoring process using Telegram. +### Telegram Bot Setup Instructions: -- Step 1: Find the telegram bot by searching ‘PowerloomReportingBot’ on Telegram -- Step 2: Type ‘/start’ to activate the bot. This will provide you with a Chat ID. +- **Step 1**: Open a new conversation with [@PowerloomReportingBot](https://t.me/PowerloomReportingBot) in the Telegram App. +- **Step 2**: Start the bot by typing `/start` to activate the bot. This will provide you with a `Chat ID`. -![chatID-start](/images/chatID-start.png) + :::note + The PowerloomSnapshotterReportingService will never ask you for any personal information or private keys. Ensure that you have started a conversation with the correct bot, and do not provide any information besides the `/start` command under any circumstances. + ::: -### If you are setting up the node for the first time, -Enter the ChatID when prompted on the terminal during the node setup. + ![chatID-start](/images/chatID-start.png) -### If you have an existing installation, -Here's what you can do: +- **Step 3**: Provide the `Chat ID` to your Snapshotter Lite node: -A. - - Update your `.env` file with the generated ChatID & the Telegram Reporting URL, as seen in the image below. - - Run the build setup again + - If you are setting up the node for the first time, enter the `Chat ID` when prompted on the terminal during the node setup: -![updated-env-screenshot](/images/updated-env-screenshot.png) + ![telegram-promp](/images/telegram-prompt.png) -OR + - If you have a running node and would like to add the Telegram reporting feature, there are two options that you can use: -B. - - Delete your existing `.env` file & Run the build setup again. - - Enter the ChatID when prompted on the terminal. + **Option 1**: Update your `.env` file with the generated `Chat ID` as seen in the image below. Once updated, run the `./build.sh` command again to restart the node. -![terminal-prompt](/images/terminal-prompt.png) + ![updated-env-screenshot](/images/updated-env-screenshot.png) + + **Option 2**: Delete your `.env` file, and then run the `./build.sh` command again to trigger a recreation of the `.env`. This will remove all values from the initial setup, so ensure that you have these available. ### To check if the Bot is successfully running, try these: diff --git a/static/images/failed-snapshot.png b/static/images/failed-snapshot.png index 070921d..01a7b79 100644 Binary files a/static/images/failed-snapshot.png and b/static/images/failed-snapshot.png differ diff --git a/static/images/telegram-prompt.png b/static/images/telegram-prompt.png new file mode 100644 index 0000000..f9da238 Binary files /dev/null and b/static/images/telegram-prompt.png differ diff --git a/static/images/updated-env-screenshot.png b/static/images/updated-env-screenshot.png index 94e805f..de86f7e 100644 Binary files a/static/images/updated-env-screenshot.png and b/static/images/updated-env-screenshot.png differ