Added environments to README
Some checks failed
Docker Push / docker (push) Has been cancelled

This commit is contained in:
Shiroyasha 2025-01-20 05:21:31 +03:00
parent 591020f04b
commit c84385bc68
Signed by: shiroyashik
GPG key ID: E4953D3940D7860A

View file

@ -3,7 +3,47 @@
Telegram бот для предложения YouTube видео на стрим.
Сделан специально для [Doggy Dox](https://www.twitch.tv/doggy_dox).
## Переменные
`DATABASE_URL=postgres://<username>:<password>@<address>/<database>`
Параметры базы данных
`TOKEN=<bot_token>`
Токен бота. Можно получить у [@botfather](tg://resolve?domain=botfather)
`ADMINISTRATORS=<user_id>[,<user_id>,...]`
ID администраторов, разделяется запятой.
Можно получить у [@getmyid_bot](tg://resolve?domain=getmyid_bot)
`CHANNEL=<chat_id>`
ID канала для проверки подписки.
Можно получить у [@getmyid_bot](tg://resolve?domain=getmyid_bot) переслав ему сообщения из канала.
`CHANNEL_INVITE_HASH=<hash>`
Хэш для инвайт ссылки (необязательно). Хэш можно извлечь из ссылки-приглашения после плюса.
Пример: `https://t.me/+<hash>`
`RUST_LOG=<level>[,target=level,...]`
Журналирование (необязательно).
Типы:
`trace, debug, info, warn, error`
Также можно указать отдельный уровень логирования для отдельных целей.
### Только для Docker
`TZ=<TZ_identifier>`
Необязательно, но рекомендуется, т.к. данные в БД хранятся без часового пояса.
Можно взять из [таблицы с Википедии](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)
Doggy Watch is licensed under [GPL-3.0](LICENSE)