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

BookStack

Подключение self-hosted вики BookStack к Charo — API-токен и индексация книг, глав и страниц.

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

  • Страницы BookStack вместе с иерархией «книга → глава → страница».
  • HTML-содержимое страниц преобразуется в текст.

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

  • Инсталляция BookStack, доступная с сервера Charo по сети.
  • Учётная запись BookStack, у роли которой включено право Access system API и доступ на чтение к нужным книгам.

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

  1. В BookStack откройте профиль пользователя → API Tokens и создайте токен.
  2. BookStack покажет Token ID и Token Secret.
  3. В Charo заполните: «Базовый URL BookStack» (адрес инсталляции), «ID API-токена BookStack» и «Секрет API-токена BookStack».

Настройка в Charo

Дополнительных полей нет: индексируются все книги, доступные учётной записи токена. Задайте название коннектора и расписание в расширенной конфигурации.

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

Не поддерживается: управляйте доступом видимостью коннектора и группами (см. «Права доступа»).

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

  • Обновления забираются инкрементально (по времени изменения) по расписанию коннектора.
  • Скорость зависит от лимитов API вашей инсталляции BookStack (API_REQUESTS_PER_MIN).

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

«401/403» при проверке

Проверьте пару ID/секрет и что у роли пользователя включено право Access system API.

Пустая индексация

У учётной записи токена нет доступа к книгам — выдайте роли доступ на чтение нужных полок и книг.

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

«Базовый URL BookStack» должен быть доступен именно с сервера Charo — проверьте адрес командой curl с сервера.