mir/the-guard-bot
2
0
Fork 0
mirror of https://github.com/thedevs-network/the-guard-bot synced 2025-08-29 21:27:47 +00:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Pouria Ezzati 2021-04-25 15:32:37 +04:30 committed by GitHub
parent 2bd6394748
commit 25cf3ef9b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 48 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
README.md
View File

@ -9,30 +9,16 @@ Initially created to moderate [The Devs Network](https://thedevs.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](https://t.me/theguardsupport).
## Table of Contents
* [Key Features](#key-features)
* [Setup](#setup)
* [Commands](#commands)
* [Plugins](#plugins)
* [Support](#support)
* [License](#license)
## 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.
## Features
* Synchronized database across multiple groups.
## Key Features
* Synchronized across multiple groups.
* Adding admins to the bot.
* Auto-remove and warn channels and groups ads.
* 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.
## 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
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.
## 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.
[**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.
---
`The Guard` icon is from [Entypo+](http://entypo.com/) by Daniel Bruce.