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

readme improvements

Browse Source
This commit is contained in:
mihalin 2021-09-16 03:32:52 +03:00
parent 16d27ac139
commit aec698ccef
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -9,20 +9,24 @@
## Возможности и преимущества Olgram Bot ## Возможности и преимущества Olgram Bot
* **Общение с клиентами**. После подключения бота, вы сможете общаться с вашими пользователями бота через диалог с ботом, либо подключенный отдельно чат, где может находиться ваш колл-центр. * **Общение с клиентами**. После подключения бота, вы сможете общаться с вашими пользователями бота через диалог с
* **Все типы сообщений**. Livegram боты поддерживают все типы сообщений — текст, фото, видео, голосовые сообщения и стикеры. ботом, либо подключенный отдельно чат, где может находиться ваш колл-центр.
* **Все типы сообщений**. Livegram боты поддерживают все типы сообщений — текст, фото, видео, голосовые сообщения и
стикеры.
* **Open-source**. В отличие от известного проекта Livegram код нашего конструктора полностью открыт. * **Open-source**. В отличие от известного проекта Livegram код нашего конструктора полностью открыт.
* **Self-hosted**. Вы можете развернуть свой собственный конструктор, если не доверяете нашему. * **Self-hosted**. Вы можете развернуть свой собственный конструктор, если не доверяете нашему.
* **Безопасность**. В отличие от Livegram, мы не храним сообщения, которые вы отправляете в бот. А наши сервера располагаются в Германии, что делает проект неподконтрольным российским властям. * **Безопасность**. В отличие от Livegram, мы не храним сообщения, которые вы отправляете в бот. А наши сервера
располагаются в Германии, что делает проект неподконтрольным российским властям.
По любым вопросам, связанным с Olgram, пишите в наш бот обратной связи @civsocit_feedback_bot По любым вопросам, связанным с Olgram, пишите в наш бот обратной связи
[@civsocit_feedback_bot](https://t.me/civsocit_feedback_bot)
### Для разработчиков: сборка и запуск проекта ### Для разработчиков: сборка и запуск проекта
Вам потребуется собственный VPS или любой хост со статическим адресом или доменом. Вам потребуется собственный VPS или любой хост со статическим адресом или доменом.
* Создайте файл .env и заполните его по образцу example.env. Вам нужно заполнить переменные: * Создайте файл .env и заполните его по образцу example.env. Вам нужно заполнить переменные:
* BOT_TOKEN - токен нового бота, получить у @botfather * BOT_TOKEN - токен нового бота, получить у [@botfather](https://t.me/botfather)
* POSTGRES_PASSWORD - любой случайный пароль * POSTGRES_PASSWORD - любой случайный пароль
* WEBHOOK_HOST - IP адрес или доменное имя сервера, на котором запускается проект * WEBHOOK_HOST - IP адрес или доменное имя сервера, на котором запускается проект
* Сохраните файл docker-compose.yaml и соберите его: * Сохраните файл docker-compose.yaml и соберите его:
@ -32,7 +36,8 @@ sudo docker-compose up -d
В docker-compose.yaml минимальная конфигурация. Для использования в серьёзных проектах мы советуем: В docker-compose.yaml минимальная конфигурация. Для использования в серьёзных проектах мы советуем:
* Приобрести домен и настроить его на свой хост * Приобрести домен и настроить его на свой хост
* Наладить реверс-прокси и автоматическое обновление сертификатов - например, с помощью [Traefik](https://github.com/traefik/traefik) * Наладить реверс-прокси и автоматическое обновление сертификатов - например, с помощью
[Traefik](https://github.com/traefik/traefik)
* Скрыть IP сервера с помощью [Cloudflire](https://www.cloudflare.com), чтобы пользователи ботов не могли найти IP адрес * Скрыть IP сервера с помощью [Cloudflire](https://www.cloudflare.com), чтобы пользователи ботов не могли найти IP адрес
хоста по Webhook бота. хоста по Webhook бота.