Разделы документации
Коннекторы

Обзор коннекторов

Все восемь источников данных Charo — вики, хранилища, задачи, почта, сайты и файлы. Какие переносят права доступа из источника.

Что такое коннекторы

Коннектор подключает источник знаний к Charo: система периодически забирает из него документы, индексирует их и делает доступными в поиске и ответах агента. Коннекторы добавляются на странице Панель администратора → Добавление коннектора.

Источников восемь. Список закрытый: подключить можно только то, что есть в таблице ниже. Для систем, которых в списке нет, остаются два обходных пути — «Веб» (индексация внутреннего портала по ссылкам) и «Файл» (выгрузки из любых систем).

Как добавляется коннектор

Настройка проходит в три шага (у части коннекторов шагов меньше):

  1. Учётные данные — выберите сохранённые или создайте новые: токен, ключ API или сервис-аккаунт источника. Что именно нужно и где это взять — на странице конкретного коннектора. Учётным данным не нужны никакие права, кроме чтения: Charo ничего не пишет обратно в источник.
  2. Настройка — название коннектора и параметры источника: что именно индексировать (пространства, проекты, диски, бакеты). У BookStack параметров нет: индексируется всё, что доступно учётным данным.
  3. Расширенная конфигурация (необязательно) — «Частота обновления» (в минутах), «Частота очистки» устаревших документов (в часах) и «Дата начала индексации».

Там же задаётся доступ к документам коннектора:

ВариантЧто означает
Приватныйдокументы видны выбранным группам пользователей Charo
Общийдокументы видны всем пользователям Charo
Автосинхронизация правCharo наследует права источника и показывает документ только тому, кому он там доступен

«Приватный» и «Автосинхронизация прав» требуют активной лицензии: без неё блок выбора доступа не показывается и все коннекторы общие. Подробнее — «Права доступа».

Все коннекторы

На экране «Добавление коннектора» карточки сгруппированы по разделам: «Популярные», «Базы знаний и вики», «Облачные хранилища», «Тикеты и задачи», «Почта» и «Прочее». Раздел «Прочее» по умолчанию скрыт (см. ниже).

ИсточникЧто индексируетсяСинхронизация прав
Confluenceстраницы, комментарии, вложения✓
BookStackполки, книги, главы, страницы, вложения страниц✓
Google Driveфайлы общих дисков и «Моих дисков»✓
S3объекты бакета S3-совместимого хранилища—
Jiraзадачи с комментариями✓
Почта (IMAP)письма выбранных ящиков или всех ящиков учётной записи—
Вебстраницы сайта и файлы по ссылкам: PDF, DOC, DOCX, XLSX, PPTX, EPUB, TXT, CSV, MD, JSON—
Файлзагруженные документы и ZIP-архивы—

Названия в таблице совпадают с подписями карточек в интерфейсе. Название карточки и название раздела — разные вещи: карточка «Почта (IMAP)» лежит в разделе «Почта», карточки «Веб» и «Файл» — в разделе «Прочее» и одновременно в «Популярных».

Из документов и вложений извлекается текст, а со сканов и изображений он распознаётся — отдельно включать это не нужно. Исключение одно: при обходе сайтов картинки не распознаются.

Единственный источник в списке, которому нужен доступ в интернет, — Google Drive: серверу Charo потребуется сетевой доступ к API Google. Confluence, Jira, BookStack и S3-совместимые хранилища подключаются внутри вашего контура.

Набор карточек может быть уже. Отдельные источники скрываются переменной окружения DISABLED_SOURCES. Переменная SHOW_EXTRA_CONNECTORS (по умолчанию false) убирает с экрана раздел «Прочее», но карточки «Веб» и «Файл» при этом остаются видимыми в разделе «Популярные» — он строится отдельно и под это скрытие не подпадает. Если нужной карточки нет, начните с настроек своей инсталляции.

Синхронизация прав

Права наследуют четыре источника: Confluence, BookStack, Google Drive и Jira. Для остальных четырёх доступ задаётся только внутри Charo — видимостью коннектора и группами пользователей.

Наследование прав означает, что Charo забирает права из самой подключённой системы: документ найдёт только тот, кому он доступен в источнике. Все четыре источника переносят и состав групп, поэтому доступ, выданный группе, работает без перечисления людей.

Права пересинхронизируются по собственному расписанию, независимо от индексации документов — примерно раз в пять минут.

Оговорки по источникам:

  • Google Drive переносит состав групп только при заполненном поле «Email администратора Workspace». Без него права файлов синхронизируются, а группы — нет.
  • Jira не различает права отдельных задач: читатели задачи — это читатели её проекта.
  • BookStack требует, чтобы у токена были права на управление ролями и пользователями. Полка при этом не передаёт права стоящим на ней книгам.

Если нужного источника нет

Напишите на contact@charo.tech — расскажите, какую систему хотите подключить.