Перейти к основному содержимому

Drupal

Об интеграции ONLYOFFICE и Drupal​

Drupal — это система управления контентом с открытым исходным кодом, используемая для создания веб-сайтов и API. ONLYOFFICE предлагает официальный модуль для интеграции ONLYOFFICE Docs с Drupal, который позволяет редактировать офисные документы в медиатеке Drupal. Модуль интеграции ONLYOFFICE можно получить на официальном сайте Drupal, выбрав нужную версию, добавить с помощью Composer или найти на странице GitHub. Модуль распространяется под лицензией GNU General Public License v.2.0.

Обратите внимание

Чтобы узнать больше о том, как работает коннектор ONLYOFFICE для Drupal, посетите страницу нашей документации по API.

Основные возможности​

  • Редактирование и просмотр текстовых документов, таблиц, презентаций и PDF-форм.
  • Совместное редактирование документов в реальном времени: два режима совместного редактирования (Быстрый и Строгий), режим Отслеживание изменений, комментарии и встроенный чат.
  • Поддержка JWT для защиты передаваемых данных: доступ к документам есть только у пользователей с соответствующими правами.
  • Предварительный просмотр файлов на публичных страницах.

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

  • Для редактирования: DOCX, XLSX, PPTX, PDF-формы.
  • Только для просмотра: DJVU, DOC, DOCM, DOT, DOTM, DOTX, EPUB, FB2, FODT, HTML, MHT, ODT, OTT, OXPS, PDF, RTF, TXT, XPS, XML, CSV, FODS, ODS, OTS, XLS, XLSM, XLT, XLTM, XLTX, FODP, ODP, OTP, POT, POTM, POTX, PPS, PPSM, PPSX, PPT, PPTM.

Подключение ONLYOFFICE Docs к Drupal​

Требования​

  • ONLYOFFICE Docs (Document Server) v7.1 или выше.

    Вам понадобится экземпляр ONLYOFFICE Docs, доступный и разрешаемый по имени как из Drupal, так и со всех клиентских устройств. Он должен иметь возможность напрямую отправлять POST-запросы в Drupal.

    Обратите внимание

    Подробнее об установке ONLYOFFICE Docs см. на официальной странице документации.

  • Основной модуль Drupal версии 10 или выше.

  • firebase/php-jwt: 6.0.0 или выше.

  • Коннектор ONLYOFFICE для Drupal

Установка модуля интеграции ONLYOFFICE для Drupal​

Модуль интеграции ONLYOFFICE для Drupal можно установить двумя способами: через пользовательский интерфейс Drupal или с помощью Composer.

Установка через пользовательский интерфейс Drupal​

  1. На странице проекта на панели инструментов Admin на drupal.org прокрутите страницу вниз до раздела Releases. Нажмите ссылку View all releases.

  2. Выберите нужную версию из списка.

  3. Скопируйте адрес ссылки на tar.gz. В зависимости от устройства и браузера это можно сделать, щелкнув правой кнопкой мыши и выбрав Copy link address.

  4. В административном меню Manage перейдите в раздел Extend (admin/modules). Откроется страница Extend.

  5. Нажмите кнопку Add new module. Откроется страница Add new module.

    ONLYOFFICE Drupal

  6. Вставьте скопированную ссылку для скачивания в поле Add from a URL.

    ONLYOFFICE Drupal

  7. Нажмите Install, чтобы загрузить и распаковать новый модуль на сервере. Файлы будут загружены в каталог модулей.

  8. Чтобы применить настройки локализации, выполните следующие команды:

    drush locale-check
    drush locale-update
Обратите внимание

Загружать новые модули через веб-интерфейс Drupal больше нельзя. О загрузке модулей в Drupal см. в следующих инструкциях.

Установка через Composer​

Введите следующую команду в корне вашего сайта Drupal:

composer require onlyoffice/onlyoffice-drupal

Если каталог установки — web/modules/contrib/drupal, выполните следующие команды, чтобы применить настройки локализации:

drush locale-check
drush locale-update

Включение модуля интеграции ONLYOFFICE для Drupal​

Модуль интеграции ONLYOFFICE для Drupal можно включить двумя способами: через пользовательский интерфейс Drupal или из командной строки.

Включение модуля интеграции ONLYOFFICE через пользовательский интерфейс Drupal​

  1. Откройте страницу Extend (admin/modules) через административное меню Manage.

  2. Найдите ONLYOFFICE Connector module и установите соответствующий флажок.

    ONLYOFFICE Drupal

  3. Нажмите Install, чтобы включить модуль.

Включение модуля интеграции ONLYOFFICE из командной строки​

  1. Выполните следующую команду Drush, указав имя проекта в качестве параметра:

    drush pm:enable onlyoffice

  2. Следуйте инструкциям мастера.

Настройка модуля интеграции ONLYOFFICE для Drupal​

В Drupal откройте страницу ~/config/system/onlyoffice-settings с административными настройками раздела ONLYOFFICE. Также можно выполнить следующие действия:

  1. Откройте страницу Extend (admin/modules) через административное меню Manage.

  2. Нажмите стрелку в описании ONLYOFFICE Connector module, чтобы открыть раскрывающийся список.

  3. Выберите пункт Configure.

  4. Введите адрес в поле Document Editing Service address, чтобы подключить ONLYOFFICE Document Server:

    https://documentserver/

ONLYOFFICE Drupal

Где documentserver — имя сервера, на котором установлен ONLYOFFICE Document Server. Адрес должен быть доступен из браузера пользователя и с сервера Drupal. Адрес сервера Drupal также должен быть доступен из ONLYOFFICE Document Server для корректной работы.

Чтобы ограничить доступ к ONLYOFFICE Document Server, а также в целях безопасности и целостности данных используется зашифрованная подпись. Укажите Secret key в административной конфигурации Drupal. В файле конфигурации ONLYOFFICE Document Server укажите тот же секретный ключ и включите проверку.

Как это работает​

Взаимодействие пользователя с документом происходит как на стороне клиента, так и на стороне сервера.

Ниже объясняются основные понятия, используемые в этой документации.

Клиентская часть включает:

  • Менеджер документов — список документов, отображаемый в браузере пользователя, в котором пользователь может выбрать нужный документ и выполнить с ним некоторые действия (в зависимости от предоставленных прав пользователь может открыть документ для просмотра или редактирования, предоставить доступ к документу другим пользователям).
  • Редактор документов — интерфейс просмотра и редактирования документов со всеми самыми известными функциями редактирования, который служит посредником между пользователем и службой редактирования документов.

Серверная часть включает:

  • Служба хранения документов — серверная служба, которая хранит все документы, доступные пользователям с соответствующими правами доступа. Она передает менеджеру документов, который пользователь видит в браузере, идентификаторы документов и ссылки на них.
  • Служба редактирования документов — серверная служба, которая позволяет просматривать и редактировать документы (если у пользователя есть соответствующие права). Интерфейс редактора документов используется для доступа ко всем функциям службы редактирования документов.
  • Служба команд документов — серверная служба, которая позволяет выполнять дополнительные команды со службой редактирования документов.
  • Служба конвертации документов — серверная служба, которая позволяет конвертировать файл документа в соответствующий формат Office Open XML (docx для текстовых документов, xlsx для таблиц и pptx для презентаций) для редактирования или скачивания.
  • Служба сборки документов — серверная служба, которая позволяет легко создавать документ без необходимости запускать редактор для обработки документов.

Обратите внимание, что ONLYOFFICE Document Server включает редактор документов, службу редактирования документов, службу команд документов, службу конвертации документов и службу сборки документов. Менеджер документов и служба хранения документов либо входят в состав Community Server, либо должны быть реализованы интеграторами программного обеспечения, которые используют ONLYOFFICE Document Server на собственном сервере.

Включение JWT для интеграции ONLYOFFICE и Drupal​

JWT, или JSON Web Token, — это строка, которую клиент отправляет серверу в HTTP-запросе для проверки подлинности клиента. JWT сохраняется только на стороне клиента, поэтому передача данных между сторонами защищена и цифрово подписана.

Токен создается по стандарту JWT (JSON Web Tokens). Токены подписываются ключом сервера, поэтому клиент может убедиться, что токен подлинный.

ONLYOFFICE Docs проверяет токен. Данные из полезной нагрузки считаются достоверными и используются вместо соответствующих данных из основных параметров. Если токен недействителен, команда не выполняется. Подробнее читайте в руководстве по безопасности API.

Чтобы защитить документы с помощью JWT в Drupal, откройте страницу ~/config/system/onlyoffice-settings с административными настройками раздела ONLYOFFICE. Также можно выполнить следующие действия:

  1. Откройте страницу Extend (admin/modules) через административное меню Manage.

  2. Нажмите стрелку в описании ONLYOFFICE Connector module, чтобы открыть раскрывающийся список.

  3. Выберите пункт Configure.

  4. Введите секретный ключ в поле Secret key.

    ONLYOFFICE Drupal

  5. В файле конфигурации ONLYOFFICE Document Server укажите тот же секретный ключ и включите проверку.

Начало работы с ONLYOFFICE Docs в Drupal​

Чтобы редактировать офисные документы в Drupal с помощью ONLYOFFICE Docs, загрузите файлы в Drupal.

Загрузка файлов в Drupal​

  1. Перейдите в Manage > Content.
  2. Нажмите кнопку Add content.
  3. Нажмите нужный тип содержимого.
  4. Введите заголовок, язык и основной текст и задайте формат текста.
  5. В поле Add a new file нажмите кнопку Browse и выберите файл на жестком диске вашего компьютера.
  6. Установите или снимите флажок Published в зависимости от ваших предпочтений.
  7. Нажмите кнопку Save.

Просмотр, редактирование файлов в Drupal и управление ими​

  1. Перейдите в Manage > Content.

  2. Перейдите на вкладку Media в верхней части экрана.

  3. Найдите нужный файл в списке или воспользуйтесь полем поиска вверху.

  4. Нажмите стрелку в столбце Operations, чтобы выбрать, что вы хотите сделать с файлом: Edit (изменить свойства файла), Edit in ONLYOFFICE или Delete.

    ONLYOFFICE Drupal

Добавление файлов в записи​

При создании записи можно добавить новый элемент ONLYOFFICE.

  1. Перейдите в Structure > Content types > нажмите Manage fields рядом с нужным полем содержимого. На открывшейся странице нажмите Add field. Добавьте новое поле: General, Number, Reference или Text. Задайте метку и сохраните.

    ONLYOFFICE Drupal

  2. Для добавленного поля File укажите расширения файлов. Перейдите в Structure > Content types > Manage fields или останьтесь на открытой странице. В поле Allowed file extensions укажите форматы файлов, которые будут отображаться в редакторах (docx, xlsx, pptx).

    ONLYOFFICE Drupal

  3. Для добавленного поля Media установите флажок Document.

    ONLYOFFICE Drupal

  4. Перейдите в Structure > Media types > Document > откройте раскрывающийся список и выберите пункт Manage display.

    ONLYOFFICE Drupal

  5. Для поля Document укажите формат ONLYOFFICE Preview. Нажав на значок шестеренки, можно задать размеры окна встроенного редактора.

    ONLYOFFICE Drupal

    Когда предварительные настройки выполнены, можно создавать записи на вкладке Content. Нажмите кнопку Add content и выберите созданный тип содержимого.

    ONLYOFFICE Drupal

Затем:

  1. Укажите заголовок и выберите файл (если содержимое включает поля File).
  2. В разделе Media укажите имя ранее загруженного файла.
  3. Посетители вашего сайта также смогут просматривать созданную страницу (People > Permissions > View published content).

Работа с PDF-формами​

Создание и загрузка PDF-формы​

  1. Перейдите в Manage → Content → ONLYOFFICE form.
  2. Нажмите кнопку Create&Upload.
  3. Чтобы создать новый файл, выберите вариант Blank в раскрывающемся меню Create form from и введите имя файла в соответствующее поле.
  4. Чтобы загрузить существующий PDF-файл, выберите вариант Upload в раскрывающемся меню Create form from.
  5. Теперь файл доступен на странице PDF Forms.

Публикация PDF-формы​

Предварительная настройка

  1. Перейдите в Manage → Structure → Content type.
  2. Выберите вариант Manage fields рядом с нужным типом содержимого.
  3. Нажмите кнопку Create a new field в левом верхнем углу открывшейся страницы Manage fields.
  4. Выберите вариант ONLYOFFICE form.
  5. Введите нужное название в поле Label.
  6. Тип содержимого, выбранный на шаге 2, теперь имеет назначенный тип ONLYOFFICE form.

Публикация

  1. Перейдите в Manage → Content → Content.
  2. Нажмите кнопку Add content в левом верхнем углу.
  3. Выберите тип содержимого, которому вы ранее назначили тип ONLYOFFICE form.
  4. Введите название созданной формы в поле ONLYOFFICE form. Если ранее созданной формы нет, нажмите кнопку Create new ONLYOFFICE form.
  5. Нажмите кнопку Save, чтобы создать страницу формы в Drupal.

Заполнение PDF-формы​

  1. Заполните поле формы.
  2. Нажмите кнопку Complete&Submit на верхней панели инструментов.
  3. Вы можете скачать копию заполненной формы. Нажмите кнопку ⋮ в правом верхнем углу и выберите, в каком формате скачать ее: .docx или .pdf.

Подробнее о заполнении форм см. в следующем руководстве.

Работа с заполненными формами​

  1. Перейдите в Manage → Content → ONLYOFFICE form → Submitted forms.
  2. Все заполненные формы сгруппированы по названию шаблона. Нажмите на название шаблона, чтобы увидеть все связанные с ним формы.
  3. Вы можете просмотреть, скачать или удалить любую из форм.
Обратите внимание

Чтобы узнать больше о наиболее распространенных проблемах и способах их решения, посетите наше руководство по устранению неполадок.