mirror of
https://gitflic.ru/project/alt-gnome/karkas.git
synced 2024-12-24 00:33:06 +03:00
правит документацию
This commit is contained in:
parent
d5e79375ae
commit
3c68318825
@ -29,6 +29,8 @@ repos:
|
|||||||
rev: 7.1.0 # sync:flake8:poetry.lock
|
rev: 7.1.0 # sync:flake8:poetry.lock
|
||||||
hooks:
|
hooks:
|
||||||
- id: flake8
|
- id: flake8
|
||||||
|
additional_dependencies:
|
||||||
|
- flake8-type-checking
|
||||||
- repo: https://github.com/PyCQA/bandit
|
- repo: https://github.com/PyCQA/bandit
|
||||||
rev: 1.7.9 # sync:bandit:poetry.lock
|
rev: 1.7.9 # sync:bandit:poetry.lock
|
||||||
hooks:
|
hooks:
|
||||||
|
@ -2,14 +2,14 @@
|
|||||||
|
|
||||||
## Описание
|
## Описание
|
||||||
|
|
||||||
Подготовленная версия Karkas Lite для интеграции в чат [Альт Линукс](https://t.me/alt_linux)
|
Подготовленная версия Karkas для интеграции в чат [Альт Линукс](https://t.me/alt_linux)
|
||||||
|
|
||||||
## Функционал
|
## Функционал
|
||||||
Список OCAB-модулей используемых в боте:
|
Список OCAB-модулей используемых в боте:
|
||||||
|
|
||||||
* report - Вызов администрации чата одной командой
|
* report - Вызов администрации чата одной командой
|
||||||
* welcome - Автоматическая вариативная проверка пользователей на признаки бота или другой автоматической рекламной системы
|
* welcome - Автоматическая вариативная проверка пользователей на признаки бота или другой автоматической рекламной системы
|
||||||
* help - Получение информации об Karkas Lite
|
* help - Получение справки о боте
|
||||||
|
|
||||||
## Запуск
|
## Запуск
|
||||||
|
|
||||||
@ -17,18 +17,18 @@
|
|||||||
|
|
||||||
1. Соберите Docker-образ:
|
1. Соберите Docker-образ:
|
||||||
```bash
|
```bash
|
||||||
docker build -t gnomik .
|
docker build -t altlinux -f Dockerfile ../..
|
||||||
```
|
```
|
||||||
2. Запустите контейнер:
|
2. Запустите контейнер:
|
||||||
```bash
|
```bash
|
||||||
docker run -p 9000:9000 -v ./config.yaml:/app/config.yaml -v ./database:/app/database gnomik
|
docker run -p 9000:9000 -v ./config.yaml:/app/config.yaml altlinux
|
||||||
```
|
```
|
||||||
|
|
||||||
Замените `./config.yaml` и `./database` на пути к вашим локальным файлам конфигурации и паки для базы данных.
|
Замените `./config.yaml` на путь к вашему локальному файлу конфигурации.
|
||||||
|
|
||||||
### Вручную
|
### Вручную
|
||||||
|
|
||||||
1. Активируйте виртуальное окружение Gnomика:
|
1. Активируйте виртуальное окружение:
|
||||||
```bash
|
```bash
|
||||||
poetry shell
|
poetry shell
|
||||||
```
|
```
|
||||||
@ -39,7 +39,9 @@
|
|||||||
|
|
||||||
## Конфигурация
|
## Конфигурация
|
||||||
|
|
||||||
Конфигурация бота находится в файле `config.yaml`.
|
Конфигурация хранится в файле `config.yaml`.
|
||||||
|
|
||||||
|
Пример конфигурации бота находится в файле `config-example.yaml`.
|
||||||
|
|
||||||
## Модули
|
## Модули
|
||||||
|
|
||||||
|
@ -2,6 +2,45 @@ core:
|
|||||||
mode: LONG_POLLING
|
mode: LONG_POLLING
|
||||||
token: xxx
|
token: xxx
|
||||||
|
|
||||||
filters:
|
#
|
||||||
approved_chat_id:
|
# filters:
|
||||||
- -111111
|
# approved_chat_id:
|
||||||
|
# - -100000000000
|
||||||
|
#
|
||||||
|
|
||||||
|
#
|
||||||
|
# welcome:
|
||||||
|
# show_success_message: True
|
||||||
|
# max_attempts: 5
|
||||||
|
# timeout: 60
|
||||||
|
# tasks:
|
||||||
|
# math_buttons:
|
||||||
|
# enabled: False
|
||||||
|
# math_poll:
|
||||||
|
# enabled: True
|
||||||
|
# question_buttons:
|
||||||
|
# enabled: False
|
||||||
|
# question_poll:
|
||||||
|
# enabled: False
|
||||||
|
#
|
||||||
|
|
||||||
|
#
|
||||||
|
# report:
|
||||||
|
# errors:
|
||||||
|
# no_reply_message: "Пожалуйста, используйте команду в ответ на сообщение"
|
||||||
|
# mention:
|
||||||
|
# text: "⚠️ Внимание, жалоба на спам! $mention"
|
||||||
|
# limit: 5
|
||||||
|
# list:
|
||||||
|
# - "@test1"
|
||||||
|
# - "@test2"
|
||||||
|
# - "@test3"
|
||||||
|
# - "@test4"
|
||||||
|
# - "@test5"
|
||||||
|
# - "@test6"
|
||||||
|
#
|
||||||
|
|
||||||
|
#
|
||||||
|
# help:
|
||||||
|
# message: "$commands"
|
||||||
|
#
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
version: '3'
|
|
||||||
|
|
||||||
services:
|
services:
|
||||||
app:
|
app:
|
||||||
build:
|
build:
|
||||||
|
Loading…
Reference in New Issue
Block a user