|
@@ -1,46 +1,18 @@
|
|
|
-# SimpleForward
|
|
|
|
|
|
|
+# podslv21_bot
|
|
|
|
|
|
|
|
-**SimpleForward** — это простой и прозрачный Telegram-бот формата «анонимные сообщения». Он пересылает контент от пользователей в целевой чат, не сохраняя и не раскрывая их личные данные. Необходимые данные для работы бота находятся только в оперативной памяти.
|
|
|
|
|
-
|
|
|
|
|
-Проект полностью открыт и распространяется под лицензией [MIT](LICENSE).
|
|
|
|
|
-
|
|
|
|
|
----
|
|
|
|
|
-
|
|
|
|
|
-## Возможности
|
|
|
|
|
-
|
|
|
|
|
-* Полностью анонимная пересылка сообщений.
|
|
|
|
|
-* Гибкая конфигурация.
|
|
|
|
|
-* Поддержка:
|
|
|
|
|
- * текста
|
|
|
|
|
- * фото
|
|
|
|
|
- * видео
|
|
|
|
|
|
|
+**podslv21_bot** — это автономный анонимный бот для платформы **Подслушано 21 школы**, который позволяет пользователям отправлять сообщения в школьный чат **не раскрывая свою личность**.
|
|
|
|
|
|
|
|
---
|
|
---
|
|
|
|
|
|
|
|
-## Настройка
|
|
|
|
|
|
|
+## Особенности
|
|
|
|
|
|
|
|
-Для конфигурации используется `config.yml`.
|
|
|
|
|
-Создайте его вручную, используя **config.yml.example**:
|
|
|
|
|
-
|
|
|
|
|
-```bash
|
|
|
|
|
-cp config.yml.example config.yml
|
|
|
|
|
-```
|
|
|
|
|
-
|
|
|
|
|
-Заполните необходимые поля — пример содержит описание всех параметров.
|
|
|
|
|
|
|
+* Бот практически полностью способен работать автономно, без участия администраторов **Подслушано 21 школы**.
|
|
|
|
|
+* Никакая личная информация не хранится в боте, бот сохраняет связи между `message_id` и `chat_id` для корректной работы ответов.
|
|
|
|
|
+* Даже администраторы не способны узнать кто отправил сообщение.
|
|
|
|
|
|
|
|
---
|
|
---
|
|
|
|
|
|
|
|
-## Запуск
|
|
|
|
|
-
|
|
|
|
|
-### Локально (Python)
|
|
|
|
|
-
|
|
|
|
|
-```bash
|
|
|
|
|
-pip install -r requirements.txt
|
|
|
|
|
-python -m simpleforward
|
|
|
|
|
-```
|
|
|
|
|
-
|
|
|
|
|
-### Через docker-compose
|
|
|
|
|
|
|
+## Модерация
|
|
|
|
|
|
|
|
-```bash
|
|
|
|
|
-docker compose up --build
|
|
|
|
|
-```
|
|
|
|
|
|
|
+* В бота интегрирована трёхуровневая автоматическая модерация через OpenAI API и `re` из python.
|
|
|
|
|
+* Модерация выполняется **автоматически перед пересылкой**, без участия администраторов.
|
Librellium