Skip to content

README-RU.md

Latest commit

 

History

History
204 lines (171 loc) · 9.71 KB

README-RU.md

File metadata and controls

204 lines (171 loc) · 9.71 KB

Napkin Tools: Taigram (Taiga Telegram Notifier)

GitHub License GitHub Actions Workflow Status Код на салфетке Заметки на салфетке

Taigram

Оглавление

  1. О проекте
  2. Требования
  3. Быстрый старт
  4. Функционал
  5. Технологии
  6. Разработка
  7. Стиль кода
  8. Авторы
  9. Лицензия
  10. Решение проблем

О проекте

Будет добавлено позже

Требования

Для корректной работы проекта, необходимо:

  • Доменное имя. Telegram не поддерживает подключение WebHook по IP-адресу и без SSL-сертификата.
  • Telegram Bot Token. Его можно создать с помощью BotFather.
  • Telegram Chat ID:
    • Для личных сообщений от бота: 1234567.
    • Для небольшой группы: -1234567
    • Для большой группы/супергруппы: -1001234567
    • Важно:
      • Для личных сообщений необходимо начать диалог с ботом.
      • Для групп необходимо добавить бота в группу и дать ему минимальные права администратора, чтобы он смог отправлять сообщения.
  • (Необязательно) Telegram Chat Thread ID. Необходим для отправки сообщений в определённую тему в супергруппе.

Быстрый старт

Для того чтобы запустить проект, достаточно выполнить несколько шагов:

  1. Подключитесь по SSH к серверу и в удобном месте создайте директорию для проекта: 
    mkdir taigram && cd taigram
  2. Скачайте конфигурационный файл и пропишите настройки:

    1. Скачайте файл:

      mkdir -p config && wget -O config/settings.yaml https://raw.githubusercontent.com/proDreams/taiga_wh_notifier/refs/heads/main/config/settings.prod_example.yaml

    2. Откройте файл для редактирования:

      nano config/settings.yaml

    3. Замените следующие параметры:

      • ADMIN_IDS - пропишите через - список главных администраторов бота.
      • ERRORS_CHAT_ID - пропишите идентификатор чата, в который будут отправляться сообщения об ошибках.
      • (необязательно) ERRORS_THREAD_ID - пропишите идентификатор темы в супергруппе, если не требуется, оставьте пустым.
      • WEBHOOK_DOMAIN - пропишите доменное имя.
      • (необязательно) DEFAULT_LANGUAGE - измените язык интерфейса бота по умолчанию.
      • (необязательно/Важно)TIME_ZONE - пропишите желаемую временную зону. По умолчанию Europe/Moscow.
      • TELEGRAM_BOT_TOKEN - пропишите токен Telegram-бота.
      • DB_URL - замените:
        • twhn_user - на собственное имя пользователя БД.
        • twhn_password - на собственный пароль БД.
      • (необязательно) DB_NAME - пропишите имя базы данных. По умолчанию taigram.

      С другими доступными параметрами конфигурации, можно ознакомиться в документации (скоро будет).

    4. Сохраните и выйдите, нажав CTRL+S, затем CTRL+X.

  3. Создайте .env-файл, заменив значения MONGO_USERNAME и MONGO_PASSWORD на прописанные ранее в settings.yaml: 
    cat <<EOF > .env
MONGO_USERNAME=twhn_user
MONGO_PASSWORD=twhn_password
EOF
  4. Скачайте docker-compose-файл:
    1. Если у вас настроен свой веб-сервер (Caddy/NGINX/etc..):
      1. Скачайте docker-compose.yaml: 
        wget -O docker-compose.yaml https://raw.githubusercontent.com/proDreams/taiga_wh_notifier/refs/heads/main/docker-compose.yaml
      2. Откройте файл для редактирования: 
        nano docker-compose.yaml
      3. Раскомментируйте в самом конце блок networks, заменив <network_name> на имя сети вашего веб-сервера, например: 
         networks:
   default:
     name: caddy-network
     external: true
      4. Сохраните и выйдите, нажав CTRL+S, затем CTRL+X.
    2. Если на сервере нет своего веб-сервера:
      1. Скачайте docker-compose.yaml: 
        wget -O docker-compose.yaml https://raw.githubusercontent.com/proDreams/taiga_wh_notifier/refs/heads/main/docker-compose.caddy.yaml
      2. Скачайте Caddyfile: 
        mkdir -p caddy && wget -O Caddyfile https://raw.githubusercontent.com/proDreams/taiga_wh_notifier/refs/heads/main/caddy/Caddyfile
      3. Откройте файл для редактирования 
        nano caddy/Caddyfile
      4. Замените example.example.com на ваше доменное имя.
      5. Сохраните и выйдите, нажав CTRL+S, затем CTRL+X.
  5. Запустите проект: 
    sudo docker compose up -d
  6. Когда бот запустится, вы получите уведомление в Telegram: 
    Service Notification: Bot started. /start

Функционал

Будет добавлено позже

Технологии

Будет добавлено позже

Разработка

Смотри подробное руководство в CONTRIBUTING-RU.md. Дополнения будут добавлены позже

Стиль кода

Смотри STYLEGUIDE-RU.md Дополнения будут добавлены позже

Авторы

Программа написана в рамках проекта "Код на салфетке":

Лицензия

Этот проект распространяется под лицензией MIT. Подробности можно найти в файле LICENSE.

Решение проблем

Позже будет перенесено в документацию

Проблема: Не запускается MongoDB с ошибкой "не поддерживается процессор без AVX-инструкций"

Решение:

  1. Открыть docker-compose.yaml для редактирования:

    nano docker-compose.yaml

  2. Найти и заменить следующие строки:

    • image: mongo на image: ghcr.io/flakybitnet/mongodb-server:7.0.16-fb2
    • MONGO_INITDB_ROOT_USERNAME: ${MONGO_USERNAME} на MONGODB_ROOT_USER: ${MONGO_USERNAME}
    • MONGO_INITDB_ROOT_PASSWORD: ${MONGO_PASSWORD} на MONGODB_ROOT_PASSWORD: ${MONGO_PASSWORD}

    Итоговый вид сервиса mongo:

    mongo:
  image: ghcr.io/flakybitnet/mongodb-server:7.0.16-fb2
  container_name: taigram_mongo
  restart: always
  environment:
    MONGODB_ROOT_USER: ${MONGO_USERNAME}
    MONGODB_ROOT_PASSWORD: ${MONGO_PASSWORD}
  volumes:
    - taigram_mongo_db:/data/db
  healthcheck:
    test: echo 'db.runCommand("ping").ok' | mongosh localhost:27017/test --quiet
    interval: 10s
    timeout: 10s
    retries: 5

  3. Сохраните и выйдите, нажав CTRL+S, затем CTRL+X.

  4. Запустите проект:

    sudo docker compose up -d