================= Петлюрик |status|

.. |status| image:: https://github.com/sweetpalma/petlyuryk/workflows/Petlyuryk%20Neural%20CI/badge.svg :target: https://github.com/sweetpalma/petlyuryk/actions/workflows/neural.yaml

Петлюрик <https://t.me/Petlyuryk>_ - перший в світі бот-русофоб. Просто додайте його в групу - і він буде наводити жах на його учасників, жорстоко караючи за будь-які прояви русизму.

Всі персонажі є вигаданими, та будь-який збіг з реально живими або померлими людьми випадковий. Позиції, вірування та точки зору висловлені цим ботом можуть різнитись з позиціями, віруваннями та точками зору його розробників.

.. image:: petlyuryk.png :width: 450px

Інсталяція

Для запуску Петлюрирка потрібні NPM та Docker. Окрім цього необхідно мати валідний Telegram-токен, який можна отримати за допомогою спеціального боту BotFather <https://core.telegram.org/bots#6-botfather>_. Подальші кроки:

• Клонуйте цей репозиторій.

• Створіть файл :code:.env в кореневій папці з наступним змістом:

  PETLYURYK_TELEGRAM_TOKEN=<Ваш Telegram-токен>

• Введіть в термінал :code:npm install для встановлення залежностей.

• Введіть в термінал :code:npm run docker для запуску самого боту.

Моніторинг

Петлюрик зберігає певні дані під час роботи, наприклад список чатів та оброблені повідомлення. Вони зберігаються у запущеному локально Redis <https://redis.io>. Для доступу до цих даних доступні як звичайний RedisInsight <http://localhost:2206> так і спеціальний дешборд самого Петлюрика <http://localhost:2205>_.

Конфіденційність

Петлюрик пропускає через себе усі повідомлення групи в яку він був доданий - але з точки зору коду ми стараємось максимально добросовісно відноситись до конфіденційності користувачів і зберігати мінімально можливий обсяг данних. Він включає в себе:

• Деталі чату (назва, юзернейм, кількість оброблених та надісланих Петлюриком повідомлень).
• Повідомлення на які була дана відповідь (відправник, текст повідомлення, текст відопвіді).

Дані які Петлюрик НЕ зберігає:

• Список користувачів чату.
• Повідомлення на які НЕ була дана відповідь.
• Додаткова інформація про користувача.

Для додаткового захисту інформація про оброблені повідомлення зберігається не більше семи днів, після чого автоматично видаляється.

Ліцензія

Петлюрика ліцензійовано згідно ліцензії GPL-3.0, що дозволяє використовувати його для будь-яких комерційних та некомерційних цілей абсолютно безкоштовно - але Ви зобов'язуєтесь використовувати цю ж ліцензію та розкривати усі подальші зміни його першокоду.