other/olgram
1
0
Fork 0
mirror of https://github.com/civsocit/olgram.git synced 2025-12-16 16:36:18 +00:00
Code Issues Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
mihalin
2021-09-16 03:20:31 +03:00
parent 62de96c500
commit 83a7d801ed
6 changed files with 118 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -1,8 +1,39 @@
# OLGram
Конструктор ботов обратной связи в Telegram
[@olgram](https://t.me/olgrambot) - конструктор ботов обратной связи в Telegram
[![Static Analysis Status](https://github.com/civsocit/olgram/workflows/Linter/badge.svg)](https://github.com/civsocit/olgram/actions?workflow=Linter)
[![Deploy Status](https://github.com/civsocit/olgram/workflows/Deploy/badge.svg)](https://github.com/civsocit/olgram/actions?workflow=Deploy)
![Logo](media/logo1_big.png)
## Возможности и преимущества Olgram Bot
* **Общение с клиентами**. После подключения бота, вы сможете общаться с вашими пользователями бота через диалог с ботом, либо подключенный отдельно чат, где может находиться ваш колл-центр.
* **Все типы сообщений**. Livegram боты поддерживают все типы сообщений — текст, фото, видео, голосовые сообщения и стикеры.
* **Open-source**. В отличие от известного проекта Livegram код нашего конструктора полностью открыт.
* **Self-hosted**. Вы можете развернуть свой собственный конструктор, если не доверяете нашему.
* **Безопасность**. В отличие от Livegram, мы не храним сообщения, которые вы отправляете в бот. А наши сервера располагаются в Германии, что делает проект неподконтрольным российским властям.
По любым вопросам, связанным с Olgram, пишите в наш бот обратной связи @civsocit_feedback_bot
### Для разработчиков: сборка и запуск проекта
Вам потребуется собственный VPS или любой хост со статическим адресом или доменом.
* Создайте файл .env и заполните его по образцу example.env. Вам нужно заполнить переменные:
** BOT_TOKEN - токен нового бота, получить у @botfather
** 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