Dependencies/olgram
1
0
Fork 1
mirror of https://github.com/civsocit/olgram.git synced 2023-07-22 01:29:12 +03:00
Code Issues Packages Projects Releases Wiki Activity
178 Commits 3 Branches 2 Tags 8.8 MiB
Python 97.1%
Shell 1.9%
Dockerfile 1%
d53a574377
Go to file
mihalin d53a574377 add images
2022-02-11 16:27:21 +03:00
.github/workflows fix for prev 2022-01-19 16:15:03 +03:00
docs add images 2022-02-11 16:27:21 +03:00
olgram flake8 2022-02-11 01:04:15 +03:00
server no spam in hroup chat 2022-02-11 04:42:19 +03:00
.dockerignore documentation first iteration 2021-09-22 19:19:11 +03:00
.flake8 fix aerich version 2022-01-18 23:42:42 +03:00
.gitignore fix #8 2021-12-22 23:46:09 +03:00
aerich.ini Миграции 2021-07-11 12:53:33 +03:00
docker-compose-debug.yaml миграция ID чата (fix #7) 2021-12-14 23:55:19 +03:00
docker-compose-full.yaml Мелкие правки по инструкции 2021-10-23 20:33:33 +03:00
docker-compose-src.yaml use poetry 2022-01-18 03:21:28 +03:00
docker-compose.yaml Мелкие правки по инструкции 2021-10-23 20:33:33 +03:00
docker-entrypoint.sh fix directory creation 2022-01-22 20:31:36 +03:00
Dockerfile use poetry 2022-01-18 03:21:28 +03:00
example.env Add possibility to set loglevel from environment. 2022-01-24 03:43:16 +03:00
LICENSE Initial commit 2021-06-11 21:58:13 +03:00
main.py logging 2022-01-19 15:48:50 +03:00
migrate.py logging 2022-01-19 15:48:50 +03:00
poetry.lock ban\unban commands 2022-01-18 23:28:03 +03:00
pyproject.toml fix for prev 2022-01-19 16:12:43 +03:00
README.md typo 2021-12-22 22:24:41 +03:00

README.md

OLGram

Static Analysis Status Deploy Status Documentation

@OlgramBot - конструктор ботов обратной связи в Telegram

Документация: https://olgram.readthedocs.io

Возможности и преимущества Olgram Bot

  • Общение с клиентами. После подключения бота, вы сможете общаться с вашими пользователями бота через диалог с ботом, либо подключенный отдельно чат, где может находиться ваш колл-центр.
  • Все типы сообщений. Olgram боты поддерживают все типы сообщений — текст, фото, видео, голосовые сообщения и стикеры.
  • Open-source. В отличие от известного проекта Livegram код нашего конструктора полностью открыт.
  • Self-hosted. Вы можете развернуть свой собственный конструктор, если не доверяете нашему.
  • Безопасность. В отличие от Livegram, мы не храним сообщения, которые вы отправляете в бот. А наши сервера располагаются в Германии, что делает проект неподконтрольным российским властям.

По любым вопросам, связанным с Olgram, пишите в наш бот обратной связи @civsocit_feedback_bot

Для разработчиков: сборка и запуск проекта

Вам потребуется собственный VPS или любой хост со статическим адресом или доменом.

  • Создайте файл .env по образцу example.env. Вам нужно заполнить переменные:
    • BOT_TOKEN - токен нового бота, получить у @botfather
    • POSTGRES_PASSWORD - любой случайный пароль
    • TOKEN_ENCRYPTION_KEY - любой случайный пароль, отличный от POSTGRES_PASSWORD
    • WEBHOOK_HOST - IP адрес или доменное имя сервера, на котором запускается проект
  • Сохраните файл docker-compose.yaml и соберите его:
sudo docker-compose up -d

В docker-compose.yaml минимальная конфигурация. Для использования в серьёзных проектах мы советуем:

  • Приобрести домен и настроить его на свой хост
  • Наладить реверс-прокси и автоматическое обновление сертификатов - например, с помощью Traefik
  • Скрыть IP сервера с помощью Cloudflire, чтобы пользователи ботов не могли найти IP адрес хоста по Webhook бота.

Пример более сложной конфигурации есть в файле docker-compose-full.yaml