mirror of
https://gitflic.ru/project/alt-gnome/karkas.git
synced 2025-03-16 07:13:47 +03:00
56 lines
1.6 KiB
Markdown
56 lines
1.6 KiB
Markdown
# ALT Linux
|
||
|
||
## Описание
|
||
|
||
Бот, созданный на основе платформы «Каркас» и подготовленный для интеграции в чат [Альт Линукс](https://t.me/alt_linux)
|
||
|
||
## Функционал
|
||
|
||
Список блоков, используемых в боте:
|
||
|
||
- `report` — вызов администрации чата одной командой;
|
||
- `welcome` — автоматическая вариативная проверка пользователей на признаки бота или другой рекламной системы;
|
||
- `help` — получение справки о боте.
|
||
|
||
## Запуск
|
||
|
||
### Через Docker образ
|
||
|
||
1. Соберите Docker образ:
|
||
|
||
```shell
|
||
docker build -t altlinux -f Dockerfile ../..
|
||
```
|
||
|
||
2. Запустите контейнер:
|
||
|
||
```shell
|
||
docker run -v ./config.yaml:/app/config.yaml altlinux
|
||
```
|
||
|
||
Замените `./config.yaml` на путь к локальному файлу конфигурации.
|
||
|
||
### Вручную
|
||
|
||
1. Активируйте виртуальное окружение:
|
||
|
||
```shell
|
||
poetry shell
|
||
```
|
||
|
||
2. Запустите бота:
|
||
|
||
```shell
|
||
python -m altlinux
|
||
```
|
||
|
||
## Конфигурация
|
||
|
||
Конфигурация хранится в файле `config.yaml`.
|
||
|
||
Пример конфигурации бота находится в файле [`config-example.yaml`](./config-example.yaml).
|
||
|
||
## Блоки
|
||
|
||
Список загружаемых блоков указан в файле [`__main__.py`](./altlinux/__main__.py).
|