https://github.com/xditya/forcesub

Force Subscribe Bot.
https://github.com/xditya/forcesub

forcesubscribe fsub telegram

Last synced: about 1 month ago
JSON representation

Force Subscribe Bot.

• Host: GitHub
• URL: https://github.com/xditya/forcesub
• Owner: xditya
• License: gpl-3.0
• Created: 2021-04-11T06:51:47.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-09-16T11:39:17.000Z (over 1 year ago)
• Last Synced: 2024-05-02T03:40:43.725Z (8 months ago)
• Topics: forcesubscribe, fsub, telegram
• Language: Python
• Homepage: https://youtu.be/8JTWG6yFi-4
• Size: 22.5 KB
• Stars: 55
• Watchers: 3
• Forks: 107
• Open Issues: 0
• Metadata Files:
  • Readme: ReadMe.md
  • License: License

Awesome Lists containing this project

README

        
# Force Subscribe Bot

Forces a user to join your group/channel so as to be able to message in a group.

# Features

- Checks for all newly joined members with a customisable welcome message.

- Checks for users who are already in the group but has not joined the channel.

# Variables

- `BOT_TOKEN` - Your telegram bot token.

- `CHANNEL` - Username of the channel/group where users must join.

- `WELCOME_MSG` - The welcome message you want.

`WELCOME_NOT_JOINED` - Welcome message to show if user is not in the channel.

- `ON_JOIN` - True/False - Set as True if the user must be muted, if not in Channel/group, directly when he joins.

- `ON_NEW_MSG` - True/False - Set as True if the user must be muted, if not in Channel/group, on sending a message.

Note: `WELCOME_MSG` and `WELCOME_NOT_JOINED` can both be formatted using parameters like `{mention}`, `{title}`, `{fullname}`, `{username}`, `{name}`, `{last}`, `{channel}` and `{count}`

# Deploy to heroku

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

# Deploy locally

Watch the tutorial on deploying - https://youtu.be/8JTWG6yFi-4

- `git clone https://github.com/xditya/ForceSub`

- `cd ForceSub`

- `pip3 install -U -r requirements.txt`

- `touch .env`,  `nano .env` and fill in the [vars](.env.sample), Ctrl+S, Ctrl+X

- Run the bot, `python3 bot.py`

# Deploy docker

Implemented by [ShadowHunterV](https://github.com/ShadowHunterV/)

- `git clone https://github.com/xditya/ForceSub`

- `cd ForceSub`

- `touch .env`,  `nano .env` and fill in the [vars](.env.sample), Ctrl+S, Ctrl+X

- Start Docker daemon (Skip If already running) `sudo dockerd`

- Build Docker image `sudo docker build . -t forcesub`

- Run the image `sudo docker run forcesub`

- To stop the running image `sudo docker ps` Then `sudo docker stop` `CONTAINER ID`

# Credits

- [Telethon](https://github.com/LonamiWebs/Telethon)

- [BotzHub](https://t.me/BotzHub)

- [Me](https://xditya.me/tg)