Modular Telegram Bot for managing your group with additional features.
Can be found as Lucifer.
The following env variables are supported:
For questions regarding creating your own bot, please head to support group where you'll find a group of volunteers to help. We'll also help when a database schema changes, and some table column needs to be modified/added (this info can also be found in the commit messages)
Join the news channel if you just want to stay in the loop about new features or announcements.
Lucifer and I can also be found moderating the support group aimed at providing help setting up Lucifer in your chats (not for bot clones). Feel free to join to report bugs, and stay in the loop on the status of the bot development.
Note to maintainers that all schema changes will be found in the commit messages, and its their responsibility to read any new commits.
Rename sample_config.yml to config.yml
lucifer_explain_config: "Ahhhhhhhhhhh i am not blind so i'll follow what the line above me asked" replace this line Ahhhhhhhhhhh i am not blind so i'll follow what the line above me asked with this lucifer_probot
The following env variables are supported:
-
bot_token: Your bot token, as a string. -
owner_id: An integer of consisting of your owner ID -
owner_username: Your username -
api_key: get it from my.telegram.org -
api_hash: get it from my.telegram.org -
database_url: Your database URL -
message_dump: optional: a chat where your replied saved messages are stored, to stop people deleting their old -
load: Space separated list of modules you would like to load -
no_load: Space separated list of modules you would like NOT to load -
webhook: Setting this to ANYTHING will enable webhooks when in env mode messages -
url: The URL your webhook should connect to (only needed for webhook mode) -
sudo_users: A space separated list of user_ids which should be considered sudo users -
whitelist_users: A space separated list of user_ids which should be considered support users (can gban/ungban, nothing else) -
support_users: A space separated list of user_ids, they can be banned. -
cert_path: Path to your webhook certifdev_usersicate -
port: Port to use for your webhooks -
del_cmds: Whether to delete commands from users which don't have rights to use that command -
strict_gban: Enforce gbans across new groups as well as old groups. When a gbanned user talks, he will be banned. -
strict_gmute: Enforce gbans across new groups as well as old groups. When a gbanned user talks, he will be banned. -
workers: Number of threads to use. 8 is the recommended (and default) amount, but your experience may vary. Note that going crazy with more threads wont necessarily speed up your bot, given the large amount of sql data accesses, and the way python asynchronous calls work. -
ban_sticker: Which sticker to use when banning people. -
allow_excl: Whether to allow using exclamation marks ! for commands as well as /.
Install the necessary python dependencies by moving to the project directory and running:
pip3 install -r requirements.txt.
This will install all necessary python packages.
If you wish to use a database-dependent module (eg: locks, notes, userinfo, users, filters, welcomes), you'll need to have a database installed on your system. I use postgres, so I recommend using it for optimal compatibility.
In the case of postgres, this is how you would set up a the database on a debian/ubuntu system. Other distributions may vary.
- install postgresql:
sudo apt-get update && sudo apt-get install postgresql
- change to the postgres user:
sudo su - postgres
- create a new database user (change YOUR_USER appropriately):
createuser -P -s -e YOUR_USER
This will be followed by you needing to input your password.
- create a new database table:
createdb -O YOUR_USER YOUR_DB_NAME
Change YOUR_USER and YOUR_DB_NAME appropriately.
- finally:
psql YOUR_DB_NAME -h YOUR_HOST YOUR_USER
This will allow you to connect to your database via your terminal. By default, YOUR_HOST should be 0.0.0.0:5432.
You should now be able to build your database URI. This will be:
sqldbtype://username:pw@hostname:port/db_name
Replace sqldbtype with whichever db youre using (eg postgres, mysql, sqllite, etc) repeat for your username, password, hostname (localhost?), port (5432?), and db name.