https://github.com/barreeeiroo/barrepolicev1
BarrePolice V1 - Check BarrePoliceV2
https://github.com/barreeeiroo/barrepolicev1
administration bot chat lua plugins redis telegram telegram-bot
Last synced: 3 months ago
JSON representation
BarrePolice V1 - Check BarrePoliceV2
- Host: GitHub
- URL: https://github.com/barreeeiroo/barrepolicev1
- Owner: barreeeiroo
- License: mit
- Created: 2017-03-07T14:48:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-20T12:22:32.000Z (almost 8 years ago)
- Last Synced: 2025-01-28T00:29:40.509Z (5 months ago)
- Topics: administration, bot, chat, lua, plugins, redis, telegram, telegram-bot
- Language: Lua
- Homepage: https://github.com/Barreeeiroo/BarrePolice
- Size: 1.73 MB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BarrePolice
## Short introduction
This bot has been created to help people administrate their groups, and includes many useful tools.
Barre Police was born as an **GroupButler** [v3.1](https://github.com/topkecleon/otouto/tree/26c1299374af130bbf8457af904cb4ea450caa51) ([`@mokubot`](https://telegram.me/mokubot)), but it has been turned into an administration bot.
#### Barre Police on Telegram:
- [`@BarrePolice_Bot`](https://telegram.me/BarrePolice_Bot)
- **_branch_**: `master`
- **_channel_**: [`@Barreeeiroo_Ch`](https://telegram.me/Barreeeiroo_Ch)
* * *
## Setup
List of required packages:
- `libreadline-dev`
- `redis-server`
- `lua5.2`
- `liblua5.2dev`
- `libssl-dev`
- `git`
- `make`
- `unzip`
- `curl`
- `libcurl4-gnutls-dev`
You will need some other Lua modules too, which can be (and should be) installed through the Lua package manager LuaRocks.
**Installation**
You can easily install Group Butler by running the following commands:
```bash
# Tested on Ubuntu 16.04
$ wget https://raw.githubusercontent.com/RememberTheAir/GroupButler/master/install.sh
$ bash install.sh
$ sudo chmod +x launch.sh
```
or
```bash
# Tested on Ubuntu 14.04, 15.04 and 16.04, Debian 7, Linux Mint 17.2
$ sudo apt-get update
$ sudo apt-get upgrade
$ sudo apt-get install libreadline-dev libssl-dev lua5.2 liblua5.2-dev git make unzip redis-server curl libcurl4-gnutls-dev
# We are going now to install LuaRocks and the required Lua modules
$ wget http://luarocks.org/releases/luarocks-2.2.2.tar.gz
$ tar zxpf luarocks-2.2.2.tar.gz
$ cd luarocks-2.2.2
$ ./configure; sudo make bootstrap
$ sudo luarocks install luasec
$ sudo luarocks install luasocket
$ sudo luarocks install redis-lua
$ sudo luarocks install lua-term
$ sudo luarocks install serpent
$ sudo luarocks install dkjson
$ sudo luarocks install Lua-cURL
$ cd ..
# Clone the repository and give the launch script permissions to be executed
# If you want to clone the beta branch, use git clone with the [-b beta] option
$ git clone https://github.com/RememberTheAir/GroupButler.git
$ cd GroupButler
$ sudo chmod 777 launch.sh
$ sudo chmod +x launch.sh
```
Other things to check before running the bot:
**First of all, take a look at your bot settings:**
> • Make sure privacy is disabled (more info can be found by heading to the [official Bots FAQ page](https://core.telegram.org/bots/faq#what-messages-will-my-bot-get)). Send `/setprivacy` to [@BotFather](http://telegram.me/BotFather) to check the current status of this setting.
**Before you do anything else, open config.lua (in a text editor) and make the following changes:**
> • Set `bot_api_key` to the authentication token that you received from [`@BotFather`](http://telegram.me/BotFather).
>
> • Insert your numerical Telegram ID into the `superadmins` table. Other superadmins can be added too. It is important that you insert the numerical ID and NOT a string.
>
> • Set your `log.chat` (the ID of the chat where the bot will send all the bad requests received from Telegram) and your `log.admin` (the ID of the user that will receive execution errors).
Before you start the bot, you have to start the Redis process.
```bash
# Start Redis
$ sudo service redis-server start
```
## Starting the process
To start the bot, run `./launch.sh`. To stop the bot, press Control CTRL+C twice.
You may also start the bot with `lua bot.lua`, however it will not restart automatically.
* * *
## Something that you should known before run the bot
* You can change some settings of the bot. All the settings are placed in `config.lua`, in the `bot_settings` table
* `cache_time.adminlist`: the permanence in seconds of the adminlist in the cache. The bot caches the adminlist to avoid to hit Telegram limits
* `notify_bug`: if `true`, the bot will send a message that notifies that a bug has occured to the current user, when a plugin is executed and an error happens
* `log_api_errors`: if `true`, the bot will send in the `log_chat` (`config.lua`) all the relevant errors returned by an api request toward Telegram
* `stream_commands`: if `true`, when an update triggers a plugin, the match will be printed on the console
* There are some other useful fields that can be filled in `config.lua`
* `db`: the selected Redis database (if you are running Redis with the default config, the available databases are 16). The database will be selected on each start/reload. Default: 2
* Other things that may be useful
* Administrators commands start for `$`. They are not documented, look at the triggers of `plugins/admin.lua` plugin for the whole list
* If the main function of a plugin returns `true`, the bot will continue to try to match the message text with the missing triggers of the `plugins` table
* You can send yourself a backup of the zipped bot folder with the `$backup` command
* The Telegram Bot API has some undocumented "weird behaviors" that you may notice while using this bot
* In supergroups, the `kickChatMember` method returns always a positive response if the `user_id` has been part of the group at least once, it doesn't matter if the user is not in the group when you use this method
* In supergroups, the `unbanChatMember` method returns always a positive response if the `user_id` has been part of the group at least once, it doesn't matter if the user is not in the group or is not in the group blacklist
## Some notes about the database
*Everything* is stored on Redis, and the fastest way to edit your database is via the [Redis CLI](http://redis.io/topics/rediscli).
You can find a backup of your Redis database in `/etc/redis/dump.rdb`. The name of this file and the frequency of saves are dependent on your redis configuration file.
* * *
## Translators
If you want to help translate the bot, follow the instructions below. Parts of Group Butler use tools from [gettext](https://www.gnu.org/software/gettext/). However we don't use binary format `*.mo` for the sake of simplicity. The bot manually parses the `*.po` files in the `locales` directory.
If you want to improve an existing translation, run this command in the root
directoy with the bot: `./launch.sh update-locale ` where <name>
is two letters of your chosen locale. Further edit the file
`locales/.po`, make sure that the translation is done correctly and send
us your translation.
We recommend [Poedit](https://poedit.net/) as editor of `*.po` files. You must
specify information about yourself in the settings; put your link to Telegram
account in the field Email if you have it.
If you want to create new locale, run `./launch.sh create-locale `. This
command create the file `locales/.po` with untranslated strings. You can
also use Poedit to translate the bot. List of avaible locales see in [gettext
manual](https://www.gnu.org/software/gettext/manual/gettext.html#Language-Codes).
After add your new locale in the file `config.lua`.
* * *
## Pull requests
We are still launching the bot for public use. Please, _be patient_
* * *
## Credits
[RememberTheAir](https://github.com/RememberTheAir), for the original [GroupButler](https://github.com/RememberTheAir/GroupButler)
[Topkecleon](https://github.com/topkecleon), for the original [otouto](https://github.com/topkecleon/otouto)
[Wrxck](https://github.com/wrxck), for the [Mattata](https://github.com/wrxck/mattata) and lots of amazing plugins
[Iman Daneshi](https://github.com/imandaneshi) and [Tiago Danin](https://github.com/TiagoDanin), for [Jack-telegram-bot](https://github.com/Imandaneshi/jack-telegram-bot)
[Cosmonawt](https://github.com/cosmonawt), for his [Lua library](https://github.com/cosmonawt/lua-telegram-bot) for the Bot API
[Yago Pérez](https://github.com/yagop) for his [telegram-bot](https://github.com/yagop/telegram-bot)
The [Werewolf](https://github.com/parabola949/Werewolf) guys, for aiding the spread of the bot
Lucas Montuano, for helping me a lot in the debugging of the bot
All the Admins of our [discussion groups](https://telegram.me/gbgroups) about Group Butler
All the people who reported bugs and suggested new stuffs
Icons made by [Roundicons](http://www.flaticon.com/authors/roundicons) from [Flaticon](https://flaticon.com) is licensed by [Creative Commons BY 3.0](http://creativecommons.org/licenses/by/3.0/)
Le Laide