Confluence

Что индексируется

• Страницы Confluence — целиком выбранные пространства, отдельные страницы (при необходимости с дочерними) или результат CQL-запроса.
• Комментарии к странице — добавляются к тексту страницы отдельным разделом со ссылкой на блок комментариев.
• Вложения к страницам — отдельными документами, а не частью страницы.
• Не индексируются: черновики и содержимое, недоступное учётным данным.
• Изображения, видео и диаграммы Gliffy не скачиваются: коннектор отсеивает их по типу содержимого до загрузки.

Коннектор работает с Confluence Server / Data Center, развёрнутым в вашем контуре. Облачный Confluence не поддерживается.

Предварительные требования

• Confluence Server / Data Center с включённым REST API, доступный с сервера Charo.
• Учётная запись с доступом на чтение к тем пространствам, которые нужно индексировать: коннектор видит ровно то, что видит эта учётная запись.

Получение учётных данных

1. Войдите под учётной записью, от имени которой будет работать коннектор (достаточно прав на чтение нужных пространств).
2. В профиле пользователя откройте Personal Access Tokens («Личные токены доступа») и создайте токен без срока истечения или с ротацией по вашему регламенту.
3. В Charo заполните «Имя пользователя Confluence» (логин) и «Токен доступа Confluence».

Коннектор авторизуется персональным токеном доступа. Пары «логин + пароль» и API-токенов Atlassian он не принимает.

Настройка в Charo

Поле	Что указать
Базовый URL вики	адрес вашего Confluence, например https://wiki.company.ru. Адрес с подкаталогом (https://intranet/confluence) поддерживается
Как индексировать ваш Confluence?	«Всё» — все доступные страницы; «Пространство» (по умолчанию) — по ключу пространства, например KB; «Страница» — идентификатор страницы, при включённом «Индексировать рекурсивно» вместе с дочерними; «CQL-запрос» — произвольная выборка

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

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

Права пересинхронизируются примерно раз в пять минут — изменения в Confluence подхватываются с этой задержкой, а не мгновенно.

Две особенности, о которых стоит знать заранее:

• Группа, в имени которой есть косая черта, не адресуется через API Confluence. Такая группа попадёт в отчёт об ошибках индексации, а её участники не получат доступ по членству.
• Почтовые адреса участников Confluence читает из профилей пользователей. Если профиль недоступен учётной записи коннектора, этот человек не будет сопоставлен с пользователем Charo.

Требуется активная лицензия; подробнее — «Права доступа».

Ограничения и частота обновления

• Обновления забираются инкрементально по расписанию коннектора («Частота обновления» в расширенной конфигурации).
• Вложения больше 10 МиБ пропускаются — вложение попадает в отчёт об ошибках индексации, а не исчезает молча.
• Коннектор обращается к Confluence не чаще пяти запросов в секунду и забирает страницы порциями по 25.
• Скорость первичной индексации ограничена лимитами API вашего Confluence; большие инсталляции индексируются часами. При необходимости поднимите лимиты запросов для сервисной учётной записи.

Устранение неполадок

Ошибка авторизации (HTTP 401)

Токен неверен или истёк. Коннектор ожидает персональный токен доступа (Personal Access Tokens в профиле пользователя), а не пароль учётной записи.

Отказ в доступе (HTTP 403)

Учётной записи не хватает прав на чтение — проверьте её доступ в самом Confluence. Charo считает 403 отказом в правах и не повторяет такой запрос.

Пространства не найдены

Проверка не нашла ни одного пространства: либо у учётной записи нет прав, либо в этой инсталляции пространств действительно нет.

Неверный ключ пространства

В поле «Ключ пространства» указан несуществующий ключ. Это именно ключ (например, KB), а не название пространства и не адрес.

Ошибка соединения

Базовый URL должен быть доступен с сервера Charo: проверьте DNS, межсетевой экран и сертификат TLS (самоподписанные сертификаты должны быть доверены на сервере Charo).