Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/denysvitali/nodegram-bot
A Telegram-bot written in Node.JS
https://github.com/denysvitali/nodegram-bot
bot js node telegram
Last synced: 10 days ago
JSON representation
A Telegram-bot written in Node.JS
- Host: GitHub
- URL: https://github.com/denysvitali/nodegram-bot
- Owner: denysvitali
- Created: 2015-06-25T00:33:30.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-10-25T09:25:41.000Z (about 8 years ago)
- Last Synced: 2024-10-11T00:52:11.305Z (27 days ago)
- Topics: bot, js, node, telegram
- Language: JavaScript
- Size: 127 KB
- Stars: 28
- Watchers: 5
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nodegram-bot
A Telegram-bot written in Node.JS
## First things first
To make your bot working you have to gather somehow a valid SSL certificate, because as stated in the docs of Telegram
> Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update.
This is the most tricky part. Once you've set-up your domain with the SSL certificate (maybe gathered ~~from [StartSSL](https://www.startssl.com/)~~ from [Let's Encrypt](https://letsencrypt.org/)) you could proceed to the configuration of apache.
### Virtual Hosts, oh, virtual hosts
In my setup I used two Apache2 servers,
I know, don't blame me, it was due to a management choice.
In this section we'll keep it simple and illustrate how to configure the Proxy Server (apache2)
```
#SSL setup
SSLEngine on
SSLProtocol all -SSLv2 -SSLv3
SSLCertificateFile "/etc/apache2/ssl/denvit.work.crt"
SSLCertificateKeyFile "/etc/apache2/ssl/denvit.work.pem"
SSLCertificateChainFile "/etc/apache2/ssl/startssl.pem"
SSLCertificateChainFile "/etc/apache2/ssl/sub.class1.server.ca.startssl.pem"
#Host info
ServerName denvit.work
ServerAlias vps.denvit.work
ProxyPreserveHost On
ProxyPass / http://127.0.0.1:30303/
ProxyPassReverse / http://127.0.0.1:30303/
```
Things you probably need to change:
- SSLCertificateFile, this is the path of your SSL certificate file
- SSLCertificateKeyFile, this is the key of your SSL pair
- ServerName, this is your hostname. The one specified into the settings.js file
- ServerAlias, this is an alias for your virtualhost (in my case it's also reachable via https://vps.denvit.work/)
Set up everything as this and just change it as you need.
The port should be 30303 if you didn't changed it into settings.js
## Running
1. install nodejs (`curl -sL https://deb.nodesource.com/setup_5.x | sudo -E bash - && sudo apt-get install -y nodejs`)
2. install the dependencies with `npm install`
3. run with `node index.js`
## Plugins
### Plugin manager
This is the father of every plugin,
its job is to enable and disable the plugins on the fly when a **superuser** wants to.
The list of enabled plugins is kept, so you don't have to manually reenable everything at startup (check data/plugins_enabled.json for more info)
#### Usage
`/plugin list`
List every plugin available (and their status)
`/plugin enable `
Enables a plugin
`/plugins disable `
Disable a plugin
`/getmyid`
Shows your ID, this is very useful if you want to add yourself to the superusers and you look for your id
### Help
This plugin takes care of supplying all the usage information about the plugins to the user when requested
#### Usage
`/help`
Shows the general help, based on the enabled plugins
`/help `
Shows the plugin informations (Name, Friendly Name, Description and Usage)
### Genmeme
Creates a meme based on a your google images search keywords and the text(s) you provide
#### Usage
`/genmeme image keywords-top text-bottom text`
### Trends
Show a graph of trend based on Google Trends
#### Usage
`/trend trend1,trend2[,trend3,...]`
### Clear
Did you ever thought of cleaning your chat?
Now you can, with Mr.Clean!
#### Result
(obviously the output is more longer)
#### Usage
`/clear`
### Version
Shows the version of the nodegram-bot
#### Result
#### Usage
`/version`