Giter Club home page Giter Club logo

lisk-cute-assistant's Introduction

Lisk Cute Assistant

Lisk-Cute-Assistant

Lisk Cute Assistant is a bot to manage your Lisk Node remotely from Telegram.

Lisk Cute Assistant enables the node owners to remotely manage it, via telegram. The code is self hosted on the same instance of the lisk node and it configures the telegram bot to only reply to requests only from a given telegram ID.

Since some operations are sensitive, it uses One Time Passwords (OTP) to authenticate the requests.

Lisk-cute-assistant doesn't perform any kind of automatic operation besides checking the health of the node/server. E.g. if your node forks, it will not automatically fix it, but instead it will give you the possibility of rebuilding the node from telegram, after executing the authentication.

Features

  • Block height check, comparing it to other nodes
  • Server stats
  • Remote rebuild from snapshot server
  • Logs tailing & logs grep
  • Minute by minute cronjobs to check the node health
  • Authentication of requests via OTP (e.g. 2FA passwords from Google Authenticator) for sensitive tasks such as the rebuild

How to run

Please follow the INSTALL.md file

Functionalities

Block Heights

It tests your blockheight against the other nodes configured in the config.js file

Server status

Returns the CPU/RAM usage, available space and the lisk process status

Rebuild from snapshot

It rebuilds the node via the command bash lisk.sh rebuild -u ${selected_snapshot_server_URL} -f latest.gz

Get logs

Opens a new keyboard that enables to:

  • Tail the logs. Yes it opens a stream from your log file with your chat. It batches the logs and sends them every second
  • Get recent logs. A single message sent once, with your last logs (tail -n 3000)
  • Grep of logs. You can grep the following:
  • Forks cause 1
  • Forks cause 2
  • Forks cause 3
  • Forks cause 4
  • Forks cause 5
  • All forks
  • SIGKILL
  • SIGABRT
  • "Consensus"

Security

The bot is programmed in a way that it only replies to your requests. For certain tasks like the rebuild flow, it requests a One Time Password in order to perform the action.

Screenshots

Todos

  • Multi node management (thanks @alepop)
  • External heartbeat check
  • Improve the snapshot rebuild possibilities (add other snapshot servers)
  • When rebuilding we should stop checking the block height, since the the node is not running (d'oh)
  • Feature to check new bot version
  • More ways to communicate a different block height (Webhooks, email, sms or call)

Disclaimer

By using this software you accept the terms and conditions. This software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. in no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

Built with ❤️ by Carbonara and Lisk Elite

lisk-cute-assistant's People

Contributors

liskprocom avatar nerdvibe avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.