The Guard Bot

Initially created to moderate The Devs Network.

NOTE: The Guard is in beta phase; it has known issues, but it's successfully being used in production

If you need help with using the Bot or setting it up, join our Support Chat.

Setup

You need Node.js (>= 12) to run this bot.

1. Create a bot via @BotFather and grab a token.
2. Clone this repository or download zip.
3. Install dependencies via npm install.
4. Copy example.config.js to config.js and edit it.
5. Start the bot via npm start.

Setup with Docker

You need to have docker installed on your machine.

1. Create a bot via @BotFather and grab a token.
2. Clone this repository or download zip.
3. Copy example.config.js to config.js and edit it.
4. Run docker build -t the_guard_bot . to build image.
5. Run docker run -v $(pwd)/data:/app/data --rm -itd the_guard_bot to start the bot.

Now you can add the bot as administrator to your groups.

Features

• Synchronized database across multiple groups.
• Adding admins to the bot.
• Auto-remove and warn channels and groups ads.
• Kick bots added by users.
• Warn and ban users to control the group.
• Commands work with replying, mentioning and ID.
• Removes commands and temporary bot messages.
• Ability to create custom commands.
• Supports plugins.

Overall, keeps the groups clean and healthy to use.

Commands

All commands and actions are synchronized across all of the groups managed by the owner and they work with replying, mentioning or ID of a user.

If used by reply, /ban and /warn would remove the replied-to message.

The bot is still in beta phase so feel free to open issues and ask for features.

Roadmap

Important Note: Under the AGPL-3.0 license, if you're running your own instance, you should add a link to the source (this repository) in your bot's bio. If you're modifying this source and making your own bot, you should link to the source of your own version of the bot according to the AGPL-3.0 license. Check LICENSE for more info.

The Guard icon is from Entypo+ by Daniel Bruce.