Доки: Connector.Client: инструкция для администратора и пользователя (Windows)

Документ описывает развертывание и повседневное использование сервиса на Windows.

Назначение

Connector.Client — фоновое приложение, которое:

• следит за папками входящих пакетов (с подписью и без);
• читает метаданные XML (формат СписокДокумент / Документ / СписокВложение);
• при необходимости подписывает файлы через CryptoPro CSP (csptest.exe);
• копирует обработанные файлы в папку приема (ServerbdropDirectory).

Остановка: закрыть окно консоли или завершить процесс; при запуске из Планировщика — «Завершить» задачу.

Требования

• Windows 10/11 или Windows Server с поддерживаемой архитектурой (x64 для готовой сборки ниже).
• Права чтения/записи ко всем каталогам из конфигурации ( signed, unsigned, server и при необходимости каталогу CryptoPro).
• При режиме CryptoProCli: установленный КриптоПро CSP, сертификат в хранилище, доступ к контейнеру закрытого ключа; утилита csptest.exe (часто C:\Program Files\Crypto Pro\CSP\).

Установка (публикация)

На машине разработчика (или Cl), где установлен .NET SDK 8:

Скопируйте содержимое папки publish на целевой MK, например:

D:\Connector\

В каталоге должны быть Connector.Client.exe ‚ appsettings.json‚ зависимые DLL и при необходимости appsettings.Development.json.

Без установки .NET на целевой машине используйте именно --self-contained (как в команде выше). 

Иначе на ПК должен быть установлен .NET Runtime 8 (x64).

Настройка конфигурации

Файлы

Основной файл: appsettings.json рядом с Connector.Client.exe.

Секция ClientConnector

Рекомендуется указывать полные пути (например D:\Connector\in\signed ), а не относительные — рабочий каталог при автозапуске может отличаться от папки с EXE.

Подробнее о формате пакетов и плоской раскладке — B README.md (раздел «Формат входного пакета»).

Секция ConnectorLogging

• Sink: File | Journal | Both (регистр не важен). Консоль пишется всегда; эта секция добавляет файл и/или журнал событий.
• LogFilePath : обязателен при File или Both. Относительный путь считается от каталога с приложением (content root).
• Journal / Both (EventLog): источник задаётся EventLogSourceName (по умолчанию Connector.Client).
  При первом использовании источника Windows может потребоваться запуск один раз от администратора (регистрация источника в реестре). Если источник уже зарегистрирован — достаточно прав обычного пользователя на запись в журнал.
• На Linux режим Journal не поддерживается (будет ошибка при старте). Режим Both на Linux добавляет только файл; консоль по-прежнему есть.

Учетная запись

Если сертификат в хранилище текущего пользователя, задание в Планировщике или автозагрузке должно выполняться под этим пользователем (вход в сеанс или явный пользователь задачи).

Запуск из командной строки

Откройте cmd или PowerShell, перейдите в каталог с EXE:

Дополнительный конфиг (мерджится с appsettings.json ):

Краткая справка и версия:

Вывод в консоль включен всегда. Дополнительно можно настроить файл и/или журнал событий в ConnectorLogging (см. раздел Секция ConnectorLogging). Окно не закрывайте, пока сервис должен работать в интерактивном режиме.

Автозапуск: папка «Автозагрузка»

Подходит для личного ПК пользователя.

1. Нажмите Win+R, выполните: shell:startup
2. Создайте ярлык на Connector.Client.exe.
3. При необходимости в свойствах ярлыка в поле «Объект» добавьте аргументы, например:

"D:\Connector\Connector.Client.exe" --config "D:\Connector\config\production.json"

Минус: нужен вход пользователя в систему. Остановка — выход из сеанса или завершение процесса через Диспетчер задач.

Автозапуск: планировщик заданий (рекомендуется для сервера/админа)

1. Откройте Планировщик заданий ( taskschd.msc ).

2. Создать задачу (не «простую»), имя, например: Connector.Client .

3. Вкладка Общие:

• Укажите пользователя, под которым есть доступ к каталогам и сертификату.
• При необходимости включите «Выполнять с наивысшими правами» (если политика безопасности требует).

4. Вкладка Триггеры:

• При входе в систему — если нужен пользовательский профиль и сертификат B CurrentUser .
• При запуске компьютера — для машинного сценария (сертификат и пути должны быть доступны этой учетной записи).

5. Вкладка Действия → Создать:

• Действие: Запуск программы.
• Программа: D:\Connector\Connector.Client.exe
• Аргументы: при необходимости --config "D:\Connector\config\production.json"
• Рабочая папка: D:\Connector (каталог с appsettings.json)

6. Условия / Параметры: при необходимости отметьте «Выполнять задачу немедленно, если пропущен плановый запуск».

Просмотр работы: вкладка Журнал задачи; вывод приложения при «в интерактивном режиме» может не отображаться — при необходимости настройте запись логов в файл (отдельная доработка или перенаправление B действии задачи через cmd /c ).

Работа пользователя

1. Убедитесь, что программа запущена (консоль, ярлык или задача в состоянии «Выполняется»).

2. Помещайте пакеты в настроенные папки:

• подкаталог с XML метаданных и файлами, или
• «плоско» в корень signed / unsigned (см. README.md ).

3. Результат появится в ServerDropDirectory: для пакета в подпапке — новая подпапка с именем исходного каталога; для плоского пакета — файлы в корне ServerDropDirectory (возможна перезапись имен).

Частые проблемы

Версия и обновление

• Версия: Connector.Client.exe --version
• Обновление: замените файлы из новой публикации publish ‚ сохраните свои appsettings*.json и внешние конфиги.