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

добавил про шифрование в документацию

Browse Source
This commit is contained in:
mihalin 2021-09-27 05:01:28 +03:00
parent 4790a21f60
commit f0237ecb0b
3 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -29,6 +29,7 @@
* Создайте файл .env по образцу example.env. Вам нужно заполнить переменные: * Создайте файл .env по образцу example.env. Вам нужно заполнить переменные:
* BOT_TOKEN - токен нового бота, получить у [@botfather](https://t.me/botfather) * BOT_TOKEN - токен нового бота, получить у [@botfather](https://t.me/botfather)
* POSTGRES_PASSWORD - любой случайный пароль * POSTGRES_PASSWORD - любой случайный пароль
* TOKEN_ENCRYPTION_KEY - любой случайный пароль, отличный от POSTGRES_PASSWORD
* WEBHOOK_HOST - IP адрес или доменное имя сервера, на котором запускается проект * WEBHOOK_HOST - IP адрес или доменное имя сервера, на котором запускается проект
* Сохраните файл docker-compose.yaml и соберите его: * Сохраните файл docker-compose.yaml и соберите его:
``` ```

6
docs/source/developer.rst
View File

@ -11,6 +11,7 @@
* ``BOT_TOKEN`` - токен нового бота, получить у `@botfather <https://t.me/botfather>`_ * ``BOT_TOKEN`` - токен нового бота, получить у `@botfather <https://t.me/botfather>`_
* ``POSTGRES_PASSWORD`` - любой случайный пароль * ``POSTGRES_PASSWORD`` - любой случайный пароль
* ``TOKEN_ENCRYPTION_KEY`` - любой случайный пароль, отличный от POSTGRES_PASSWORD
* ``WEBHOOK_HOST`` - IP адрес или доменное имя сервера, на котором запускается проект * ``WEBHOOK_HOST`` - IP адрес или доменное имя сервера, на котором запускается проект
2. Рядом с файлом .env сохраните файл 2. Рядом с файлом .env сохраните файл
@ -22,6 +23,11 @@
Готово, ваш собственный Olgram запущен! Готово, ваш собственный Olgram запущен!
.. warning::
Не потеряйте TOKEN_ENCRYPTION_KEY! Его нельзя восстановить. В случае утери TOKEN_ENCRYPTION_KEY вы потеряете
токены всех ботов, которые пользователи зарегистрировали в вашем боте.
Дополнительно Дополнительно
------------- -------------

2
example.env
View File

@ -5,7 +5,7 @@ POSTGRES_PASSWORD=SOME_RANDOM_PASSWORD_HERE # example: x2y0n27ihiez93kmzj82
POSTGRES_DB=olgram POSTGRES_DB=olgram
POSTGRES_HOST=postgres POSTGRES_HOST=postgres
TOKEN_ENCRYPTION_KEY=SOME_RANDOM_KEY # example: TOKEN_ENCRYPTION_KEY=SOME_RANDOM_PASSWORD_HERE # example: i7flci0mx4z5patxnl6m
WEBHOOK_HOST=YOUR_HOST_HERE # example: 11.143.142.140 or my_domain.com WEBHOOK_HOST=YOUR_HOST_HERE # example: 11.143.142.140 or my_domain.com
WEBHOOK_PORT=8443 # allowed: 80, 443, 8080, 8443 WEBHOOK_PORT=8443 # allowed: 80, 443, 8080, 8443