karkas/src/altlinux/README.md

# ALT Linux

## Описание

Подготовленная версия Karkas Lite для интеграции в чат [Альт Линукс](https://t.me/alt_linux)

## Функционал
Список OCAB-модулей используемых в боте:

* report - Вызов администрации чата одной командой
* welcome - Автоматическая вариативная проверка пользователей на признаки бота или другой автоматической рекламной системы
* help - Получение информации об Karkas Lite

## Запуск

### Docker

1. Соберите Docker-образ:
    ```bash
    docker build -t gnomik .
    ```
2. Запустите контейнер:
    ```bash
    docker run -p 9000:9000 -v ./config.yaml:/app/config.yaml -v ./database:/app/database gnomik
    ```

    Замените `./config.yaml` и `./database` на пути к вашим локальным файлам конфигурации и паки для базы данных.

### Вручную

1. Активируйте виртуальное окружение Gnomика:
    ```bash
    poetry shell
    ```
2. Запустите бота:
    ```bash
    python -m gnomik
    ```

## Конфигурация

Конфигурация бота находится в файле `config.yaml`.

## Модули

Список загружаемых модулей указан в файле `__main__.py`.