mirror of
https://github.com/thedevs-network/the-guard-bot
synced 2025-08-30 13:47:54 +00:00
Update README.md
This commit is contained in:
72
README.md
72
README.md
@@ -9,30 +9,16 @@ Initially created to moderate [The Devs Network](https://thedevs.network).
|
|||||||
**NOTE: The Guard is in beta phase;**
|
**NOTE: The Guard is in beta phase;**
|
||||||
**it has known issues, but it's successfully being used in production**
|
**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](https://t.me/theguardsupport).
|
## Table of Contents
|
||||||
|
* [Key Features](#key-features)
|
||||||
|
* [Setup](#setup)
|
||||||
|
* [Commands](#commands)
|
||||||
|
* [Plugins](#plugins)
|
||||||
|
* [Support](#support)
|
||||||
|
* [License](#license)
|
||||||
|
|
||||||
## Setup
|
## Key Features
|
||||||
You need [Node.js](https://nodejs.org/) (>= 12) to run this bot.
|
* Synchronized across multiple groups.
|
||||||
|
|
||||||
1. Create a bot via [@BotFather](https://t.me/BotFather) and grab a **token**.
|
|
||||||
2. Clone this repository or [download zip](https://github.com/TheDevs-Network/the-guard-bot/archive/master.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](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#install-from-a-package) installed on your machine.
|
|
||||||
|
|
||||||
1. Create a bot via [@BotFather](https://t.me/BotFather) and grab a **token**.
|
|
||||||
2. Clone this repository or [download zip](https://github.com/TheDevs-Network/the-guard-bot/archive/master.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.
|
* Adding admins to the bot.
|
||||||
* Auto-remove and warn channels and groups ads.
|
* Auto-remove and warn channels and groups ads.
|
||||||
* Kick bots added by users.
|
* Kick bots added by users.
|
||||||
@@ -44,6 +30,26 @@ Now you can add the bot as **administrator** to your groups.
|
|||||||
|
|
||||||
Overall, keeps the groups clean and healthy to use.
|
Overall, keeps the groups clean and healthy to use.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
You need [Node.js](https://nodejs.org/) (>= 12) to run this bot.
|
||||||
|
|
||||||
|
1. Create a bot via [@BotFather](https://t.me/BotFather) and grab a **token**.
|
||||||
|
2. Clone this repository or [download zip](https://github.com/TheDevs-Network/the-guard-bot/archive/master.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](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#install-from-a-package) installed on your machine.
|
||||||
|
|
||||||
|
1. Create a bot via [@BotFather](https://t.me/BotFather) and grab a **token**.
|
||||||
|
2. Clone this repository or [download zip](https://github.com/TheDevs-Network/the-guard-bot/archive/master.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.
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
Command | Role | Available at | Description
|
Command | Role | Available at | Description
|
||||||
----------------------- | ---------- | ------------ | -----------------
|
----------------------- | ---------- | ------------ | -----------------
|
||||||
@@ -73,12 +79,30 @@ All commands and actions are synchronized across all of the groups managed by th
|
|||||||
|
|
||||||
If used by reply, `/ban` and `/warn` would remove the replied-to message.
|
If used by reply, `/ban` and `/warn` would remove the replied-to message.
|
||||||
|
|
||||||
|
## Plugins
|
||||||
|
|
||||||
|
The guard is extensible in form of plugins where custom features and commands can be easily added to it. To use a plugin, put it in the [/plugins](/plugins) directory and add its name to plugins array in config.js.
|
||||||
|
Checkout our [Plugins' Wiki](https://github.com/thedevs-network/the-guard-bot/wiki/Plugins) page for more information.
|
||||||
|
|
||||||
|
**Known plugins**:
|
||||||
|
|
||||||
|
* [Captcha](https://gist.github.com/poeti8/d84dfc4538510366a2d89294ff52b4ae): Adds a simple captcha to the bot to kick spam bots on join.
|
||||||
|
* [Banfiles](https://gist.github.com/poeti8/133796200d66049c9bd58e6265a52f68) Ban users that send files with specified extentions.
|
||||||
|
* [Anti Arabic](https://gist.github.com/poeti8/966ccef35d61ad2735dc0120ce3e8760) Bans users that send an Arabic/Persian message.
|
||||||
|
* [Anti X-POST](https://gist.github.com/poeti8/c3057f973466676ca8dbbb1183cd0624) Removes same messages sent by user across one or multiple groups.
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
If you need help with using the Bot or setting it up, join our [Support Chat](https://t.me/theguardsupport).
|
||||||
|
|
||||||
The bot is still in beta phase so feel free to [open issues](https://github.com/thedevs-network/the-guard-bot/issues/new) and ask for features.
|
The bot is still in beta phase so feel free to [open issues](https://github.com/thedevs-network/the-guard-bot/issues/new) and ask for features.
|
||||||
|
|
||||||
[**Roadmap**](https://github.com/TheDevs-Network/the-guard-bot/projects/1)
|
[**Roadmap**](https://github.com/TheDevs-Network/the-guard-bot/projects/1)
|
||||||
|
|
||||||
---
|
## License
|
||||||
|
|
||||||
> 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)](https://github.com/TheDevs-Network/the-guard-bot) 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](LICENSE) for more info.
|
> 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)](https://github.com/TheDevs-Network/the-guard-bot) 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](LICENSE) for more info.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
`The Guard` icon is from [Entypo+](http://entypo.com/) by Daniel Bruce.
|
`The Guard` icon is from [Entypo+](http://entypo.com/) by Daniel Bruce.
|
||||||
|
Reference in New Issue
Block a user