2024-08-11 09:13:30 +03:00
|
|
|
|
# ALT Linux
|
|
|
|
|
|
|
|
|
|
## Описание
|
|
|
|
|
|
2024-08-25 14:52:07 +03:00
|
|
|
|
Бот, созданный на основе платформы «Каркас» и подготовленный для интеграции в чат [Альт Линукс](https://t.me/alt_linux)
|
2024-08-11 09:13:30 +03:00
|
|
|
|
|
|
|
|
|
## Функционал
|
|
|
|
|
|
2024-08-25 14:52:07 +03:00
|
|
|
|
Список блоков, используемых в боте:
|
|
|
|
|
|
|
|
|
|
- `report` — вызов администрации чата одной командой;
|
|
|
|
|
- `welcome` — автоматическая вариативная проверка пользователей на признаки бота или другой рекламной системы;
|
|
|
|
|
- `help` — получение справки о боте.
|
2024-08-11 09:13:30 +03:00
|
|
|
|
|
|
|
|
|
## Запуск
|
|
|
|
|
|
2024-08-25 14:52:07 +03:00
|
|
|
|
### Через Docker образ
|
|
|
|
|
|
|
|
|
|
1. Соберите Docker образ:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
docker build -t altlinux -f Dockerfile ../..
|
|
|
|
|
```
|
2024-08-11 09:13:30 +03:00
|
|
|
|
|
|
|
|
|
2. Запустите контейнер:
|
|
|
|
|
|
2024-08-25 14:52:07 +03:00
|
|
|
|
```shell
|
|
|
|
|
docker run -v ./config.yaml:/app/config.yaml altlinux
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Замените `./config.yaml` на путь к локальному файлу конфигурации.
|
2024-08-11 09:13:30 +03:00
|
|
|
|
|
|
|
|
|
### Вручную
|
|
|
|
|
|
2024-08-25 14:52:07 +03:00
|
|
|
|
1. Активируйте виртуальное окружение:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
poetry shell
|
|
|
|
|
```
|
|
|
|
|
|
2024-08-11 09:13:30 +03:00
|
|
|
|
2. Запустите бота:
|
2024-08-25 14:52:07 +03:00
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
python -m altlinux
|
|
|
|
|
```
|
2024-08-11 09:13:30 +03:00
|
|
|
|
|
|
|
|
|
## Конфигурация
|
|
|
|
|
|
2024-08-25 14:52:07 +03:00
|
|
|
|
Конфигурация хранится в файле `config.yaml`.
|
|
|
|
|
|
|
|
|
|
Пример конфигурации бота находится в файле [`config-example.yaml`](./config-example.yaml).
|
2024-08-11 09:13:30 +03:00
|
|
|
|
|
2024-08-25 14:52:07 +03:00
|
|
|
|
## Блоки
|
2024-08-11 09:13:30 +03:00
|
|
|
|
|
2024-08-25 14:52:07 +03:00
|
|
|
|
Список загружаемых блоков указан в файле [`__main__.py`](./altlinux/__main__.py).
|