sticker-bot

Sticker packs telegram bot

Try it right now!

@paces_bot

Installation

Bot simply can be installed by running code on machine using required variables in .env file

If you’re using webhooks, you should set up reverse proxy. You can start with aiogram documentation or read tutorial on webhooks (the tutorial is in ukrainian🇺🇦). Both use nginx and tutorial uses certbot.

Installation guide step by step

1. Requirements

• Python >3.10.x
• pip
• postgresql or mongodb
• git

1. Clone project

git clone https://github.com/RoLO0u/sticker-bot.git

1. Install python requirements

pip install -r requirements.txt

:warning: when having problems installing psycopg2: try running

on debian:

sudo apt-get install libpq-dev

on arch:

sudo pacman -Sy postgresql-libs

source

on Amazon Linux:

sudo yum -y install gcc python-setuptools python-devel postgresql-devel

source

on MacOS:

brew install postgresql

1. Set environment variables

Environment variables can be seen in Required variables part or in .env.example file

1. Run programm

To run programm use simple command depending on your configuration:

python main.py

If you want to save logs in main.log, you can use --log-file arg

python main.py --log-file

Or use virtual environment variables AND docker

Required variables

Database configuration

• DB - db name, which will be used for bot to store users info.

  In current version either “mongodb” or “postgresql”

If you’re using mongodb

• MONGO_URI ─ uri to your mongo database

:warning: mongodb isn’t being tested: try on your own risk

If you’re using postgresql

• PGDATABASE - database information will be stored in. e.g. aiogram, to create use

  CREATE DATABASE aiogram; -- or another database name
  

• PGHOST - your address to the postgresql. On local machines should be 127.0.0.1
• PGPORT - port to your postgresql server. Most likely 5432
• PGUSER - user who will be used to execute commands with (e.g. postgres).
• PGPASSWORD - password to user

Telegram bot configuration

• BOT_TOKEN ─ token bot will use to interact with telegram API

  Use @BotFather to get bot token

Debugging

• DEBUG - either True or False. If False only shows WARNING level logs.

Long polling

• WEBHOOK - False if you want to use long polling

Webhook

• WEBHOOK - True
• WEBHOOK_SECRET ─ a string of random characters. Read more here.
• BASE_WEBHOOK_URL ─ an URL to which telegram will send updates to

  If you’re using self-signed certificate you should add certificate file to set_webhook method in launch.py file

• WEBHOOK_SSL_CERT ─ path to your public certificate
• WEBHOOK_SSL_PRIV ─ path to your private/secret certificate

  Make sure your user can read the file, otherwise the PermissionError will be raised

  Optional

• WEBHOOK_PATH - path to the bot e.g. “telegram-sticker-bot”
• SERVER_HOST - local IPv4 e.g. 127.0.0.1
• SERVER_PORT - local port used e.g. 8080

If you’re encountering issues, read aiogram documentation or official telegram documentation

Migration, database testing, updating

Run db_cli.py script to execute sql from “sql_queries” folder.

When using choose script to execute by entering its number or quit by entering “q”

Resources

• aiogram 3 documentation

• Telegram API

• Anti-flood bot

This site is open source. Improve this page.