Skip to content

Latest commit

 

History

History
91 lines (76 loc) · 3.19 KB

README.md

File metadata and controls

91 lines (76 loc) · 3.19 KB
Raw

rise-checker

Current version: 2.0

This script checks the status of your RISE delegate by using PHP.
Feel free to rewrite in Python or Bash.

This script will also check whether your node has forked or not.
When forked, it will stop RISE, restore to previous snapshot, and start RISE again.

This script will also check your consensus and switch forging to your backup node.
When both nodes have a bad consensus, it will restart RISE and let you know by sending a Telegram message.

IMPORTANT TO MENTION If you want to use the consensus controller, you need to add your secret(s) to config.php and remove them from your RISE config.json. Also, you have to give access to the forging API calls for both nodes. Like this (1.2.3.4 is the extra IP):

    "forging": {
        "force": false,
        "secret": [],
        "access": {
            "whiteList": [
                "127.0.0.1","1.2.3.4",
            ]
        }
    },

There are some echo lines in this file.
When you redirect output to a log file in your crontab, these lines will show up.
See section Example crontab for more information.

Be sure to run this script after:

  • You have installed rise-snapshot
  • You have created a snapshot with rise-snapshot

Prerequisites

Be sure that your php.ini allows passthru(). It's default that it does though, so just check if this script is not working.

sudo apt install php php-cli php-mbstring php-sqlite3

Installation

You can clone this into every directory of your choosing. I usually just clone it into my home folder.

git clone https://github.com/lepetitjan/rise-checker.git
  • Change settings inside config.php to match your needs
  • Edit your crontab with the example below

Example crontab

* * * * * php ~/rise-checker/checkdelegate.php >> ~/rise-checker/logs/checkdelegate.log 2>&1

Telegram bot

Rise-Checker comes with Telegram functionality which will allow rise-checker to send you a message if anything requires your attention. It's very easy to set up:

  • Open Telegram and start a conversation with: userinfobot
  • Put your ID inside variable $telegramId.
$telegramId = "12345678";
  • Start a conversation with: botfather
  • Say: /newbot
  • Tell botfather your bot's name
  • Tell botfather your bot's username
  • Botfather will say "Congratulations!" and give you a token
  • Put your token inside variable $telegramApiKey.
$telegramApiKey 	= "1122334455:AAEhBOweik6ad9r_QXMENQjcrGbqCr4K-bs";
  • Edit the telegram toggle (true/false)
  • Start a conversation with your bot (username) to enable communication between you two

Contact

Donations

Do you like/use my script(s)? Please consider donating the amount of a cup of coffee :-)
BTC: 1GbAWBiGyuybXJcjtyTvtH6hB5iezXNVdP

Contributors

Seatrips (create snapshot when status is okay)

Mrgr (Shift snapshot)

Lepetitjan (Rise snapshot)