Настройка интеграции с OnlyOffice Docs

Предварительные требования (Обязательное условие)

Для настройки интеграции необходимо предварительно развернуть сервер ONLYOFFICE Docs (Document Server).

Официальные дистрибутивы ONLYOFFICE Docs для различных операционных систем, а также руководства по их установке доступны в официальной документации ONLYOFFICE.

После успешного развертывания ONLYOFFICE Docs на отдельном сервере можно переходить к пошаговой настройке интеграции с Vitro-CAD.

1. Схема сетевого взаимодействия

Для работы редактора должны выполняться 4 сетевых соединения:

• DocumentServerUrl — сетевой адрес сервера ONLYOFFICE Docs. Должен быть доступен из браузеров пользователей и с сервера Vitro-CAD.
• PortalPublicUrl — сетевой адрес сервера Vitro-CAD. Должен быть доступен с сервера ONLYOFFICE Docs.

2. Проверка Vitro-CAD и настройка просмотрщика файлов

Проверка версии

1. Убедитесь, что версия серверной части Vitro-CAD — не ниже 2026.1.5.3.
2. Если потребовалось обновление сервера, после его проведения перезапустите службу Vitro Server.

Настройка просмотрщика в Центре администрирования (GUI)

Чтобы при клике на файл соответствующего формата открывался редактор ONLYOFFICE Docs, необходимо вручную назначить просмотрщик для нужных расширений:

1. Перейдите в Центр администрирования Vitro-CAD.
2. В левом боковом меню выберите раздел Настройки → Списки → Расширения файлов. Список скрытый.
3. Нажмите на необходимое расширение в списке (например, docx, xlsx, pptx и т. д.).
4. В правой панели свойств найдите поле Просмотрщик файлов.
5. Введите или выберите из выпадающего списка значение Only Office (onlyOffice).
6. Сохраните изменения.
7. Повторите процедуру для остальных целевых расширений файлов.

Поддерживаемые форматы:

• Документы: doc, docm, docx, dot, dotm, dotx, odt, ott, rtf, txt;
• Таблицы: csv, ods, ots, xls, xlsb, xlsm, xlsx, xlt, xltm, xltx;
• Презентации: odp, otp, pot, potm, potx, pps, ppsm, ppsx, ppt, pptm, pptx.

Проверка назначения просмотрщика через БД (опционально)

Проверить корректность привязки просмотрщика в базе данных можно с помощью SQL-запроса:

SELECT
fe.internal_name AS extension,
fv.internal_name AS viewer
FROM public.file_extension fe
LEFT JOIN public.file_viewer fv ON fv.id = fe.file_viewer
WHERE fe.internal_name IN (
'doc', 'docm', 'docx', 'dot', 'dotm', 'dotx', 'odt', 'ott', 'rtf', 'txt',
'csv', 'ods', 'ots', 'xls', 'xlsb', 'xlsm', 'xlsx', 'xlt', 'xltm', 'xltx',
'odp', 'otp', 'pot', 'potm', 'potx', 'pps', 'ppsm', 'ppsx', 'ppt', 'pptm', 'pptx'
)
ORDER BY fe.internal_name;

Для всех настроенных расширений в колонке viewer должно отображаться значение onlyOffice.

3. Сетевой доступ между серверами

1. Выберите адреса подключения:
   1. DocumentServerUrl (например, https://docs.example.ru/ —  сетевой адрес сервера ONLYOFFICE Docs, доступный с рабочих мест и с сервера Vitro-CAD.
   2. PortalPublicUrl (например, https://vitro.example.ru/ —  сетевой адрес Vitro-CAD, доступный с сервера ONLYOFFICE Docs.
      
      
2. Проверьте доступность адресов и портов между серверами:
   1. Windows (PowerShell):
      

      Test-NetConnection docs.example.ru -Port 443
      Test-NetConnection vitro.example.ru -Port 443

   2. Linux (Bash):
      

      curl -I https://docs.example.ru/healthcheck
      curl -I https://vitro.example.ru/

      
      

4. Настройка Vitro-CAD (onlyoffice.json)

1. Создайте или отредактируйте файл onlyoffice.json на сервере Vitro-CAD:
   1. Windows: C:\Program Files\Vitro Software\Vitro\Server\Conf\onlyoffice.json
   2. Linux: /etc/Vitro/Server/Conf/onlyoffice.json

2. Укажите параметры конфигурации:
   

   {
   	"DocumentServerUrl": "https://docs.example.ru/",
   	"PortalPublicUrl": "https://vitro.example.ru/",
   	"JwtSecret": "<JWT_SECRET>",
   	"SessionLookupDays": 7
   }

Параметры конфигурации:

После изменения onlyoffice.json необходимо перезапустить Vitro Server.

5. Настройка JWT в ONLYOFFICE Docs

1. Сгенерируйте случайный секрет длиной 32 байта:

1. • Windows (PowerShell):

     $bytes = New-Object byte[] 32
     $generator = [System.Security.Cryptography.RandomNumberGenerator]::Create()
     $generator.GetBytes($bytes)
     [Convert]::ToBase64String($bytes)
     $generator.Dispose()
     

   • Linux:

     openssl rand -base64 32
     

2. Укажите полученное значение в параметре JwtSecret файла onlyoffice.json.
3. Откройте файл local.json на сервере ONLYOFFICE Docs:
   1. Windows: C:\Program Files\ONLYOFFICE\DocumentServer\config\local.json
   2. Linux: /etc/onlyoffice/documentserver/local.json
4. Включите проверку JWT и укажите тот же секрет (добавьте в файл local.json):
   

   {
     "services": {
       "CoAuthoring": {
         "token": {
           "enable": {
             "browser": true,
             "request": {
               "inbox": true,
               "outbox": true
             }
           }
         },
         "secret": {
           "inbox": {
             "string": "<JWT_SECRET>"
           },
           "outbox": {
             "string": "<JWT_SECRET>"
           },
           "session": {
             "string": "<JWT_SECRET>"
           }
         }
       }
     }
   }

Разрешение доступа к частным IP-адресам

Если PortalPublicUrl содержит частный IP-адрес, ONLYOFFICE Docs может заблокировать загрузку файла и callback. В этом случае добавьте в local.json на сервере ONLYOFFICE Docs:

 {
  "services": {
    "CoAuthoring": {
      "request-filtering-agent": {
        "allowPrivateIPAddress": true,
        "allowMetaIPAddress": false
      }
    }
  }
}

6. HTTPS и сертификаты

Для производственной установки следует использовать доверенные сертификаты и HTTPS для Vitro-CAD и ONLYOFFICE Docs.

Необходимо проверить два независимых условия:

1. Браузеры пользователей доверяют сертификату DocumentServerUrl.
2. Сервер ONLYOFFICE Docs доверяет сертификату PortalPublicUrl.

7. Перезапуск служб

После изменения local.json на сервере ONLYOFFICE Docs и onlyoffice.json на сервере Vitro-CAD перезапустите службы.

На сервере ONLYOFFICE Docs и Vitro-CAD (Linux):

sudo systemctl restart ds-converter ds-docservice ds-metrics
sudo systemctl restart vitro-server

На сервере ONLYOFFICE Docs (Windows PowerShell от имени администратора):

Restart-Service DsConverterSvc
Restart-Service DsDocServiceSvc
Restart-Service DsProxySvc

После этого перезапустите службу Vitro Server на сервере Vitro-CAD. Открытые вкладки редактора в браузерах пользователей необходимо перезагрузить.

8. Проверка работы интеграции

Проверка доступности ONLYOFFICE Docs

С рабочего места пользователя и с сервера Vitro-CAD выполните:

Invoke-WebRequest "https://docs.example.ru/healthcheck" -UseBasicParsing
Invoke-WebRequest "https://docs.example.ru/web-apps/apps/api/documents/api.js" -UseBasicParsing

Запрос healthcheck должен вернуть true, оба запроса должны завершиться со статусом 200.

Проверка связи ONLYOFFICE с Vitro-CAD

С сервера ONLYOFFICE Docs проверьте доступность PortalPublicUrl:

curl -I https://vitro.example.ru/

После открытия документа ONLYOFFICE Docs обращается к адресу:

/onlyOffice/api/editor/getDocument/...

Проверка открытия и сохранения

1. В Vitro-CAD откройте файл docx, xlsx или pptx.
2. Убедитесь, что файл открылся в новой вкладке ONLYOFFICE.
3. Внесите изменение и нажмите кнопку сохранения.
4. Закройте вкладку редактора.
5. Проверьте появление новой версии файла в Vitro-CAD.

9. Права пользователей

Vitro-CAD передает в ONLYOFFICE идентификатор и имя пользователя текущей сессии.

10. Диагностика и устранение неполадок

Журналы (логи) ONLYOFFICE Docs:

• Windows: C:\Program Files\ONLYOFFICE\DocumentServer\Log\docservice, ...\converter
• Linux: /var/log/onlyoffice/documentserver/docservice/, ...\converter

11. Текущие ограничения

• История изменений и changes.zip не сохраняются отдельно в Vitro-CAD и не отображаются в интерфейсе истории ONLYOFFICE.
• Сравнение версий средствами ONLYOFFICE не подключено.
• Редактируется только актуальная версия; исторические версии открываются только для просмотра.
• После ForceSave финальный callback со статусом 2 может создать дополнительную версию с тем же содержимым.