Добро пожаловать в документацию Olgram

Olgram @olgrambot это конструктор, который позволяет создавать боты обратной связи в Telegram. После подключения к Olgram пользователи вашего бота смогут писать сообщения, которые будут пересылаться вам в чат, где вы сможете на них ответить. Читайте больше о проекте в главе О проекте.

Откройте главу Быстрый старт чтобы приступить к созданию своего первого бота!

Оглавление

О проекте

Зачем нужен Olgram?

Olgram - это конструктор ботов обратной связи. Такие боты могут вам пригодиться, например:

Пример 1. Вы администрируете Telegram-канал и хотите дать своим подписчикам возможность связаться с вами, но не хотите оставлять свои личные контакты. Тогда вы можете создать бота обратной связи: подписчики будут писать боту, вы будете отвечать через бота анонимно.

Пример 2. Вы организуете небольшой call-центр в Telegram или группу технической поддержки. С помощью бота обратной связи вы можете принимать заявки от пользователей в общий чат ваших специалистов, обсуждать эти заявки и отвечать пользователям прямо из этого чата.

Примечание

Olgram - молодой развивающийся проект. Мы готовы расширить функционал бота под ваш сценарий использования, если он не является слишком узкоспециализированным и пригодится другим пользователям. Напишите нам по этому вопросу @civsocit_feedback_bot.

Почему не Livegram?

Наше принципиальное отличие от Livegram это открытость и безопасность.

  • Olgram не хранит сообщения, которые вы пересылаете через него

  • Код нашего проекта полностью открыт

  • Вы можете развернуть Olgram на своём собственном сервере (читайте Для разработчиков)

  • Наши сервера находятся в Германии, мы не подконтрольны российскому или белорусскому правительству

Всё это позволяет вам использовать Olgram (в отличие от Livegram) в политических и других серьёзных проектах.

Примечание

Если у вас возникли вопросы по использованию бота, или вы нашли ошибку - напишите нам @civsocit_feedback_bot.

Быстрый старт

Как создать бота

Перейдите по ссылке @Olgram и нажмите Запустить:

_images/start2.jpg

TODO: дальше

Как изменить текст приветствия

По-умолчанию ваш бот после запуска отправляет приветственное сообщение:

Здравствуйте! Напишите свой вопрос, и мы ответим вам в ближайшее время

TODO: дальше

Как привязать бота к групповому чату

По-умолчанию вам бот пересылает сообщения от пользователей вам в личные сообщения.

Для разработчиков

Сборка и запуск

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

1. Создайте файл .env и заполните его по образцу example.env Вам нужно заполнить переменные:

  • BOT_TOKEN - токен нового бота, получить у @botfather

  • POSTGRES_PASSWORD - любой случайный пароль

  • WEBHOOK_HOST - IP адрес или доменное имя сервера, на котором запускается проект

2. Сохраните файл docker-compose.yaml и соберите его:

(bash) $ sudo docker-compose up -d

Готово, ваш собственный Olgram запущен!

Дополнительно

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

  • Приобрести домен и настроить его на свой хост

  • Наладить реверс-прокси и автоматическое обновление сертификатов - например, с помощью Traefik

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

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

Примечание

Если у вас возникли вопросы по использованию бота, или вы нашли ошибку - напишите нам @civsocit_feedback_bot.