https://github.com/kamikazechaser/ServerBot

:bulb: A Telegram Bot For Checking Server Statistics And Information.
https://github.com/kamikazechaser/ServerBot

telegram-bot

Last synced: about 2 months ago
JSON representation

:bulb: A Telegram Bot For Checking Server Statistics And Information.

• Host: GitHub
• URL: https://github.com/kamikazechaser/ServerBot
• Owner: kamikazechaser
• License: gpl-3.0
• Archived: true
• Created: 2016-07-31T14:10:46.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-05-03T06:10:20.000Z (over 7 years ago)
• Last Synced: 2024-06-11T02:05:24.026Z (3 months ago)
• Topics: telegram-bot
• Language: JavaScript
• Homepage:
• Size: 33.2 KB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ServerBot

A 💡Telegram Bot For Checking **Server Statistics And Information.**

[![https://github.com/kamikazechaser/LiveCoinBot/blob/master/LICENSE.md](https://img.shields.io/badge/license-GNU%20GPLv3-lightgrey.svg)](https://github.com/kamikazechaser/LiveCoinBot/blob/master/LICENSE.md)

[![https://telegram.me/kamikazechaser](https://img.shields.io/badge/%F0%9F%92%AC_Telegram-kamikazechaser-blue.svg)](https://telegram.me/kamikazechaser)

[![Dependency Status](https://david-dm.org/kamikazechaser/ServerBot.svg)](https://david-dm.org/kamikazechaser/ServerBot)

[![devDependencies Status](https://david-dm.org/kamikazechaser/ServerBot/dev-status.svg)](https://david-dm.org/kamikazechaser/ServerBot?type=dev)

[![Code Climate](https://codeclimate.com/github/kamikazechaser/ServerBot/badges/gpa.svg)](https://codeclimate.com/github/kamikazechaser/ServerBot)

## Installation

- _Ensure you have NodeJS and npm installed else visit [here](https://nodejs.org/en/download/package-manager/)_

- _Preferrable to use with tmux or screen_

- _If you have a windows server edit the bot.js file as commented on line 53_

- _Replace your token in bot.js_

- _Add your userId so as to use the bot (or an array of users)_

```bash

$ npm install -g nodemon

$ git clone https://github.com/kamikazechaser/ServerBot.git && cd ServerBot

$ npm install

$ nodemon bot.js

```

## Commands

_As a security precaution, due to sensitivity of certain commands, e.g /bash, the bot will ignore ALL messages that are not from the SuperUser a.k.a sudo!_

Command | Description

--- | ---

/start | Displays general information about the bot and list of commands.

/bash [cmd] | Execute UNIX commands on the machine and get a reply if any _(directory cannot be changed)_.

/info | Gets the general information of the server.

/disk | Displays the storage information of the server.

/ram | Displays the memory information of the server.

/load | Displays the CPU load of the server.

/ping | Initiates the speed-test (takes 12 - 20 seconds). You will be notified on start and end of speed-test. 

/results | Displays the speed-test results.

/geo | Geo-locates the server.

## License

 

    ServerBot

    Copyright (C) 2016 Mohammed Sohail 

    This program is free software: you can redistribute it and/or modify

    it under the terms of the GNU General Public License as published by

    the Free Software Foundation, either version 3 of the License, or

    (at your option) any later version.

    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License

    along with this program.  If not, see .