From 59408aaacd1c09ece8b3e6242d0b31da8c20bcc9 Mon Sep 17 00:00:00 2001 From: mihalin Date: Tue, 8 Mar 2022 04:21:38 +0300 Subject: [PATCH] readme --- README.md | 42 +++++++++++------------------------------- 1 file changed, 11 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 57214c9..ca0d876 100644 --- a/README.md +++ b/README.md @@ -8,39 +8,19 @@ Документация: https://olgram.readthedocs.io -## Возможности и преимущества Olgram Bot -* **Общение с клиентами**. После подключения бота, вы сможете общаться с вашими пользователями бота через диалог с -ботом, либо подключенный отдельно чат, где может находиться ваш колл-центр. -* **Все типы сообщений**. Olgram боты поддерживают все типы сообщений — текст, фото, видео, голосовые сообщения и -стикеры. -* **Open-source**. В отличие от известного проекта Livegram код нашего конструктора полностью открыт. -* **Self-hosted**. Вы можете развернуть свой собственный конструктор, если не доверяете нашему. -* **Безопасность**. В отличие от Livegram, мы не храним сообщения, которые вы отправляете в бот. А наши сервера -располагаются в Германии, что делает проект неподконтрольным российским властям. +**Olgram** [@OlgramBot](https://t.me/olgrambot) это конструктор, который позволяет создавать боты обратной связи +в Telegram. После подключения к Olgram пользователи вашего бота смогут писать сообщения, которые будут +пересылаться вам в чат, где вы сможете на них ответить. +Такие боты могут вам пригодиться, например: -По любым вопросам, связанным с Olgram, пишите в наш бот обратной связи -[@civsocit_feedback_bot](https://t.me/civsocit_feedback_bot) + *Пример 1.* Вы администрируете Telegram-канал и хотите дать своим подписчикам возможность связаться с вами, + но не хотите оставлять свои личные контакты. Тогда вы можете создать бота обратной связи: подписчики будут писать + боту, вы будете отвечать через бота анонимно. -### Для разработчиков: сборка и запуск проекта + *Пример 2.* Вы организуете небольшой call-центр в Telegram или группу технической поддержки. С помощью бота обратной + связи вы можете принимать заявки от пользователей в общий чат ваших специалистов, обсуждать эти заявки и отвечать + пользователям прямо из этого чата. -Вам потребуется собственный VPS или любой хост со статическим адресом или доменом. -* Создайте файл .env по образцу example.env. Вам нужно заполнить переменные: - * BOT_TOKEN - токен нового бота, получить у [@botfather](https://t.me/botfather) - * POSTGRES_PASSWORD - любой случайный пароль - * TOKEN_ENCRYPTION_KEY - любой случайный пароль, отличный от POSTGRES_PASSWORD - * WEBHOOK_HOST - IP адрес или доменное имя сервера, на котором запускается проект -* Сохраните файл docker-compose.yaml и соберите его: -``` -sudo docker-compose up -d -``` - -В docker-compose.yaml минимальная конфигурация. Для использования в серьёзных проектах мы советуем: -* Приобрести домен и настроить его на свой хост -* Наладить реверс-прокси и автоматическое обновление сертификатов - например, с помощью -[Traefik](https://github.com/traefik/traefik) -* Скрыть IP сервера с помощью [Cloudflire](https://www.cloudflare.com), чтобы пользователи ботов не могли найти IP адрес -хоста по Webhook бота. - -Пример более сложной конфигурации есть в файле docker-compose-full.yaml +Читайте больше: https://olgram.readthedocs.io