From c84385bc68fb62de634e7353e8461656a0745aca Mon Sep 17 00:00:00 2001 From: shiroyashik Date: Mon, 20 Jan 2025 05:21:31 +0300 Subject: [PATCH] Added environments to README --- README.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3d8abbb..5ddfcc2 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,47 @@ Telegram бот для предложения YouTube видео на стрим. Сделан специально для [Doggy Dox](https://www.twitch.tv/doggy_dox). +## Переменные + +`DATABASE_URL=postgres://:@
/` + +Параметры базы данных + +`TOKEN=` + +Токен бота. Можно получить у [@botfather](tg://resolve?domain=botfather) + +`ADMINISTRATORS=[,,...]` + +ID администраторов, разделяется запятой. +Можно получить у [@getmyid_bot](tg://resolve?domain=getmyid_bot) + +`CHANNEL=` + +ID канала для проверки подписки. +Можно получить у [@getmyid_bot](tg://resolve?domain=getmyid_bot) переслав ему сообщения из канала. + +`CHANNEL_INVITE_HASH=` + +Хэш для инвайт ссылки (необязательно). Хэш можно извлечь из ссылки-приглашения после плюса. +Пример: `https://t.me/+` + +`RUST_LOG=[,target=level,...]` + +Журналирование (необязательно). +Типы: +`trace, debug, info, warn, error` +Также можно указать отдельный уровень логирования для отдельных целей. + +### Только для Docker + +`TZ=` + +Необязательно, но рекомендуется, т.к. данные в БД хранятся без часового пояса. +Можно взять из [таблицы с Википедии](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) + ## Contributing + ![Спроси меня о чём угодно!](https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg) в [![Telegram](https://badgen.net/static/icon/Telegram?icon=telegram&color=cyan&label)](https://t.me/shiroyashik) @@ -28,4 +68,4 @@ Telegram бот для предложения YouTube видео на стрим ## License -Doggy Watch is licensed under [GPL-3.0](LICENSE) \ No newline at end of file +Doggy Watch is licensed under [GPL-3.0](LICENSE)