An open API service indexing awesome lists of open source software.

https://github.com/akkilmg/maintainance-bot

This Is A Simple Bot Repo For Devs When Your Bots Are On Maintainance
https://github.com/akkilmg/maintainance-bot

Last synced: 3 months ago
JSON representation

This Is A Simple Bot Repo For Devs When Your Bots Are On Maintainance

Awesome Lists containing this project

README

          

Maintenance Bot




Cover Image





A Telegram Repo For Bots Under Maintenance


Requests »


Report a Bug
|
Request Feature


Table of Contents



  1. About this Bot


  2. How to make your own


  3. Setting up things


  4. How to use the bot

  5. To Be Added

  6. Credits

## About This Bot



Telegram Logo



This Bot Is For Developers, If Your Bot Is Down, Use This Repo To Give Your Dear Subscribers Some Support By Providing Them Response.

## How to make your own

Either you could locally host or deploy on [Heroku](https://heroku.com)

### Deploy on Heroku

Press the below button to Fast deploy on Heroku

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/AkkilMG/Maintainance-Bot/tree/master/)

then goto the variables tab for more info on setting up environmental variables.

### Host it on VPS or Locally

```sh
git clone https://github.com/HeimanPictures/Maintainance-Bot
cd Maintainance-Bot
virtualenv -p /usr/bin/python3 venv
. ./venv/bin/activate
pip install -r requirements.txt
python3 -m plugins
```

and to stop the whole bot,
do CTRL+C

## Setting up things

If you're on Heroku, just add these in the Environmental Variables
or if you're Locally hosting, create a file named `.env` in the root directory and add all the variables there.
An example of `.env` file:

```sh
APP_ID=123456
API_HASH=esx576f8738x883f3sfzx83
BOT_TOKEN=12345678:yourtbottokenhere
UPDATE_CHANNEL=https://t.me/HeimanSupports
SUPPORT_GROUP=https://t.me/HeimanSupport
AUTH_USERS=your_user_id
MAINTAINANCE_TEXT=your-text
WEBHOOK=ANYTHING (Keep It Default)
```

### Mandatory Variables

- `APP_ID` : Go to [my.telegram.org](https://my.telegram.org) to obtain this.
- `API_HASH` : Go to [my.telegram.org](https://my.telegram.org) to obtain this.
- `BOT_TOKEN` : Get the bot token from [@BotFather](https://telegram.dog/BotFather)

### Non-mandatory Variables

- `UPDATE_CHANNEL`: Updates channel link
- `SUPPORT_GROUP`: Support group link
- `PRIVATE_ONLY`
- `FILTER_TEXT`
- `FILTER_MEDIA`

## How to use the bot

- `/start` : To check if the bot is alive or not.

Check This [Click Here](#about-this-bot)

## To Be Added:

- Added Broadcast Feature!
- Made Better Bin Channel Logging!

## Credits

- Logo By [poppit](https://telegram.dog/poppit/)
- [AkKiL M G](https://github.com/AkkilMG/)

## LICENSE

```
Copyright (C) 2021 AkKiL M G

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see .
```