Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Zoom-Developer authored Nov 18, 2024
1 parent 7578e70 commit a5e8fbf
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@
## Настройка

Переименуйте `.env.example` в `.env` и обновите в нём следующие значения:
- **DB_HOST**, **DB_PORT**, **DB_USER**, **DB_PASSWORD**, **DB_NAME** замените на свои значения подключения базе данных или поставьте на стандартные (например postgres, postgres, postgres), потому что порты БД не выведены в сеть и остаются внутри закрытой докер сети.
- **DB_HOST**, **DB_PORT**, **DB_USER**, **DB_PASSWORD**, **DB_NAME** замените на свои значения подключения к базе данных или поставьте на стандартные (например postgres, postgres, postgres), потому что порты БД не выведены в сеть и остаются внутри закрытой докер сети.
- **TG_TOKEN** - токен вашего ТГ бота
- **TG_ADMIN_CHAT** - ID закрытого админ-чата формата `-100XXXXXXXXXX`
- Поля, которые при необходимости можно удалить из .env
- **TG_CHANNEL_ID** - ID канала, подписка на который необходима для использования формата `-100XXXXXXXXXX`
- **TG_CHANNEL_ID** - ID канала, подписка на который необходима для использования аппа. Формата `-100XXXXXXXXXX`
- **TG_CHANNEL_LINK** - ссылка на канал формата `t.me/channel`
- **API_URL** - Итоговый URL API сервиса *(https://example.com/api)*
- **ROOT_PATH** - Коренной путь для API, используемый после проксирования *(в случае если архитектура изменяться не будет, оставить на текущее)*
- **LOKI_URL** - на данный момент не используется
- **RABBIT_URL** - путь до RabbitMQ *(в случае если архитектура изменяться не будет, оставить на текущее)*

Бот должен быть добавлен в админ чат, выдача ему админ-прав необязательна, его команды будут работать только в этом чате
Бот также должен быть добавлен в канал, в случае если вы используете эту проверку (в противном случае строки, отвечающие за это должны быть удалены из .env)
Бот также должен быть добавлен в канал, в случае если вы используете эту проверку (в противном случае строки, отвечающие за это, должны быть удалены из .env)

Архитектура подразумевает проксирование через внешний веб-сервер, например **Apache** или **Nginx**, поэтому необходимо настроить полное проксирование до `127.0.0.1:8022`, данный адрес при стандартной конфигурации будет работать только в локальной сети.
При необходимости можно настроить проксирование до сервиса **Grafana**, расположенного по адресу `127.0.0.1:8023`. В случае если в этом нет необходимости, объявление этого сервиса стоит удалить из `docker-compose.yaml`
Expand Down

0 comments on commit a5e8fbf

Please sign in to comment.