M.vinogradov: initial version

2026-05-25T06:47:52Z

initial version

New page

== Демонстрационная сборка ==

Установка демонстрационной версии Svacer с поддержкой [[Help:13-alpha_introduction|описанных функций]] доступна только в докере с использованием docker compose

== docker compose ==

Для установки демонстрационной версии подготовлен специальный файл [https://svacer.ispras.ru/extra/docker-compose-with-ai-llm-mcp.yml docker-compose-with-ai-llm-mcp.yml]

<nowiki>curl -LO https://svacer.ispras.ru/extra/docker-compose-with-ai-llm-mcp.yml</nowiki>

При запуске Svacer с использованием данного compose-файла доступны профили:

{| class="wikitable"
! Профиль !! Описание
|-
| Без профиля || Запуск Svacer без поддержки ИИ-ассистента и MCP
|-
| <code>ai</code> || Запуск Svacer с поддержкой ИИ-ассистента со встроенной моделью
|-
| <code>llm</code> || Запуск Svacer с поддержкой ИИ-ассистента и возможностью подключения к нему внешних LLM для разметки предупреждений
|-
| <code>mcp</code> || Запуск Svacer с MCP-сервером
|}

Для запуска с использованием одного или нескольких профилей используется команда

docker compose -f docker-compose-with-ai-llm-mcp.yml ... --profile llm --profile mcp ... up -d

При этом необходимо учитывать, что

* при запуске Svacer без профилей или только с профилем <code>mcp</code> функциональность разметки предупреждений с помощью ИИ будет возвращать ошибку;

* запуск с профилями <code>llm</code> и <code>mcp</code> требует настройки переменных окружения (см. ниже).

Для удобства настройки переменных окружения может использоваться env-файл [https://svacer.ispras.ru/extra/llm-mcp.env llm-mcp.env], который после установки необходимых значений может быть передан команде запуска

docker compose -f docker-compose-with-ai-llm-mcp.yml --env-file ./llm-mcp.env ... --profile llm --profile mcp ... up -d



== <code>--profile llm</code> ==
Запуск Svacer с данным профилем даёт возможность подключить к ИИ-ассистенту внешний сервис моделей, поддерживающий OpenAI API. После успешного подключения ИИ-ассистент сможет использовать LLM для разметки и комментирования предупреждений. В списке разметки с помощью ИИ появятся модели доступные пользователю, чей ключ был передан при запуске.

При запуске Svacer с профилем <code>llm</code> необходимо:
* установить в переменную окружения <code>LLM_URL</code> значение url по которому контейнер <code>svacer-validation-server</code> сможет подключиться к сервису моделей, совместимому с OpenAI API;
* установить в переменную окружения <code>LLM_TOKEN</code> значение ключа авторизации в сервис моделей;
* при необходимости установить значения переменных <code>REG_TOKEN</code> или <code>REG_LOGIN</code> и <code>REG_PASSWORD</code> содержащих, соответственно, токен авторизации или логин и пароль администратора. Эти данные нужны для запуска компонентов поддержки LLM в ИИ-ассистенте. По умолчанию будут использоваться логин и пароль <code>admin:admin</code>;
* при желании изменить отображаемое название сервиса в интерфейсе выбора моделей, можно установить значение переменной <code>REG_NAME</code>. По умолчанию: <code>llm</code>;
* при необходимости ограничения списка доступных моделей, в переменную <code>MODEL_WHITELIST</code> нужно передать список названий моделей разделённых запятыми;
* если производительность сервиса моделей позволяет параллельно обрабатывать несколько предупреждений, то можно установить значение переменной <code>MAX_PARALLEL_REQUESTS</code> в значение больше единицы;
* если производительность модели не позволяет обрабатывать одно предупреждение в минуту, то результаты обработки не будут получены. Чтобы увеличить время ожидания новых результатов модели, можно установить значение переменной <code>MODEL_VALIDATION_MAXATTEMPTS</code> в значение кратное 12 (двенадцати). Например: значение 60 == 5 минут.

В процессе обработки набора маркеров с помощью LLM ИИ-ассистент ожидает, что за минуту будет обрабатываться хотя бы один маркер. Если в течение минуты не появятся новы

Значения данных переменных могут быть сохранены в <code>.env</code> файл и переданы при запуске с помощью аргумента <code>docker compose --env-file ./.env ... up -d</code>

Описание переменных доступных для конфигурации запуска ИИ-ассистента с поддержкой внешнего сервиса моделей:
<pre>
# URL of the OpenAI API-compatible LLM hosting service
LLM_URL=

# LLM hosting service authorization token
LLM_TOKEN=

# Svacer admin authorization token, which will be used to perform LLM service registration requests in the AI assistant.
# Or with REG_LOGIN and REG_PASSWORD, if token is not set
# REG_TOKEN=

# Svacer admin login and password
# REG_LOGIN=admin
# REG_PASSWORD=admin

# ID of the service in the AI assistant
# REG_ID=llm

# The name of the service displayed in the AI assistant
# REG_NAME=llm

# Service description
# REG_DESCRIPTION="LLM hosting service"

# Comma-separated list of available models. If not specified, all models available to the LLM hosting service user will be available.
# MODEL_WHITELIST=

# Maximum number of simultaneous requests to process warning with LLM
# MAX_PARALLEL_REQUESTS=1

# Maximum number of 5s attempts to get single warning result from LLM
# MODEL_VALIDATION_MAXATTEMPTS=12
</pre>

== <code>--profile mcp</code> ==
При запуске с данным профилем стартует контейнер с MCP-сервером подключённый к текущему экземпляру Svacer.

При запуске Svacer с профилем <code>llm</code> необходимо:
* установить в переменную окружения <code>MCP_PORT</code> номер сетевого порта на котором будет доступен MCP-сервер. По умолчанию будет назначен порт <code>8002</code>.
* установить в переменную окружения <code>SVACER_MPC_TOKEN</code> строку с токеном авторизации, который необходимо будет указать в клиенте MCP-сервера;
* при необходимости доступа к MCP-серверу по адресу отличному от <code>localhost</code> (<code>127.0.0.1</code>) или при использовании DNS необходимо:
** указать необходимый адрес/dns-имя в переменной <code>MCP_ALLOWED_HOSTS</code> в виде <code>172.17.0.1:*</code>/<code>some.domain:*</code>
** указать необходимый адрес/dns-имя в переменной <code><nowiki>MCP_ALLOWED_ORIGINS</nowiki></code> в виде <code><nowiki>http://172.17.0.1:*</nowiki></code>/<code><nowiki>http://some.domain:*</nowiki></code>
* При необходимости можно настроить логин и пароль пользователя, от имени которого mcp-сервер будет выполнять запросы к Svacer. По умолчанию: <code>admin:admin</code>

После запуска mcp-сервер будет доступен по адресу <code><nowiki>http://localhost:{MCP_PORT}/mcp</nowiki></code>

Описание других переменных доступных для конфигурации запуска ИИ-ассистента с поддержкой внешнего сервиса моделей:
<pre>
# Bearer token for /mcp clients in HTTP mode. Generate: openssl rand -hex 32
SVACER_MCP_TOKEN=

# Svacer admin login and password
SVACER_LOGIN=admin
SVACER_PASSWORD=admin

# External port that will be mapped by docker to the internal port 8000
MCP_PORT=8002

MCP_ALLOWED_HOSTS=172.17.0.1:*
MCP_ALLOWED_ORIGINS=http://172.17.0.1:*

# Svacer server (container) URL
# SVACER_URL=http://svacer:8080

# HTTP timeout for requests to Svacer, seconds
# SVACER_TIMEOUT=30

# Public URL of this MCP server (used for WWW-Authenticate, RFC 9728).
# Defaults to http://localhost:<SVACER_HTTP_PORT>. Set when running behind a reverse proxy.
# SVACER_MCP_RESOURCE_URL=https://mcp.example.com

# Subset of tools to register (comma-separated). Unset = all 8 tools.
# Available: get_projects, get_snapshots, get_warnings, get_markers,
# get_project_stats, get_project_groups, get_advanced_file_preview, get_diff
# SVACER_TOOLS=get_projects,get_snapshots,get_markers
</pre>

Help:13-alpha installation - Revision history

M.vinogradov: initial version