Liferay

Requisitos

• Servidor de documentos de ONLYOFFICE v6.1.0 (servidor o versión en nube) o posterior.

  Necesitas una instancia de ONLYOFFICE Docs que sea resoluble y conectable tanto desde Liferay como desde cualquier cliente final. Debe poder hacer POST directamente a Liferay.

  Por favor, consulta la página de documentación oficial para aprender más sobre la instalación de ONLYOFFICE Docs.
• Liferay CE Portal 7.2 GA1+, Liferay DXP 7.2 GA1+, Liferay CE Portal 7.3 GA1+, Liferay DXP 7.3 GA1+, Liferay CE Portal 7.4 GA1+, Liferay CE 7.4 GA44 - GA73, Liferay DXP 7.4 U44 - U73.
• Conector ONLYOFFICE v2.2.0 para Liferay.

Instalación del conector ONLYOFFICE para Liferay

Puedes instalar el conector de ONLYOFFICE usando el Administrador de Aplicaciones.

Para instalarlo usando el Administrador de Aplicaciones:

1. Navega a Panel de Control > Sistema > Administrador de Aplicaciones.
2. Haz clic en el botón Opciones.
3. Haz clic en el botón Subir.
4. En la ventana abierta, elige el archivo de la aplicación ONLYOFFICE.

Cuando la instalación se complete, la aplicación estará lista para su uso.

Si estás construyendo el conector por ti mismo, simplemente coloca el archivo .jar compilado desde la carpeta build\libs en /opt/liferay/deploy. Liferay lo instalará automáticamente.

Compilando el Conector ONLYOFFICE para Liferay

Simplemente ejecuta gradle build. El archivo .jar de salida se colocará dentro del directorio build/libs.

Configurando el conector de ONLYOFFICE para Liferay

Ve a Panel de Control > Configuración > Configuración del Sistema. En la sección Plataforma, elige la categoría Conectores y selecciona ONLYOFFICE.

Aquí puedes configurar los siguientes ajustes:

• Dirección de ONLYOFFICE Docs - especifica la dirección URL donde está instalado el Servicio de Edición de Documentos.
  La dirección de ONLYOFFICE Docs debe ser accesible desde Liferay, así como la dirección de Liferay debe ser accesible desde ONLYOFFICE Docs.
• Dirección de ONLYOFFICE Docs para solicitudes internas desde el servidor - especifica la dirección que se utiliza para acceder al Servicio de Edición de Documentos desde Liferay.
• Dirección del servidor para solicitudes internas desde ONLYOFFICE Docs - especifica la dirección que se utiliza para acceder a Liferay desde el Servicio de Edición de Documentos.
• Clave secreta - especifica la clave secreta utilizada para firmar los datos.
  A partir de ONLYOFFICE Docs v7.2, JWT está habilitado por defecto y la clave secreta se genera automáticamente. Necesitas habilitarlo también en el lado de Liferay: encuentra tu clave secreta en el archivo de configuración de ONLYOFFICE Docs, luego especifica la misma clave secreta en la configuración del conector. Para más detalles, consulta la sección Habilitar JWT para la integración de ONLYOFFICE y Liferay de este artículo.
• Habilitar Guardado Forzado - activa la casilla para mantener versiones intermedias del documento al editar.
• Habilitar Vista Previa Web de ONLYOFFICE - activa la casilla para habilitar la vista previa de archivos.

Después de configurar la aplicación de integración, haz clic en el botón Guardar para aplicar los cambios.

Cómo funciona

La integración de ONLYOFFICE utiliza la API documentada aquí.

1. El usuario navega a la sección Documentos y Medios dentro de Liferay y selecciona la acción Editar en ONLYOFFICE.
2. Liferay prepara un objeto JSON para el Servidor de Documentos con las siguientes propiedades:
   • url: la URL que ONLYOFFICE Docs utiliza para descargar el documento;
   • callbackUrl: la URL que ONLYOFFICE Docs utiliza para informar sobre el estado de la edición del documento;
   • key: el fileVersionId para instruir a ONLYOFFICE Docs si debe descargar el documento nuevamente o no;
   • title: el título del documento (nombre).
3. El navegador del cliente realiza una solicitud a la biblioteca JavaScript de ONLYOFFICE Docs y envía a ONLYOFFICE Docs la configuración de DocEditor con las propiedades mencionadas.
4. Luego, ONLYOFFICE Docs descarga el documento desde Liferay y el usuario comienza a editar.
5. ONLYOFFICE Docs envía una solicitud POST a callbackUrl para informar a Liferay que un usuario está editando el documento.
6. Liferay bloquea el documento, pero aún permite que otros usuarios con acceso de escritura colaboren en tiempo real con ONLYOFFICE Docs dejando la Acción presente.
7. Cuando todos los usuarios y navegadores de los usuarios han terminado de editar, cierran la ventana de edición.
8. Después de 10 segundos de inactividad, ONLYOFFICE Docs envía un POST a callbackUrl informando a Liferay que los clientes han terminado de editar el documento y lo han cerrado.
9. Liferay descarga una nueva versión del documento, reemplazando la anterior.

Habilitar JWT para la integración de ONLYOFFICE y Liferay

Para proteger los documentos del acceso no autorizado, los editores de ONLYOFFICE utilizan el JSON Web Token (JWT). El token se añade a la configuración cuando se inicializa el Editor de Documentos y durante el intercambio de comandos entre los servicios internos de ONLYOFFICE Docs. La clave secreta se utiliza para firmar el token web JSON y validar el token al realizar solicitudes a ONLYOFFICE Docs.

A partir de ONLYOFFICE Docs v7.2, JWT está habilitado por defecto y la clave secreta se genera automáticamente. Necesitas encontrar tu clave secreta en el archivo de configuración de ONLYOFFICE Docs, luego especifica la misma clave secreta en la configuración del conector.

Paso 1: Encuentra tu clave secreta en el archivo de configuración de ONLYOFFICE Docs

1. Abre el archivo local.json con cualquier editor de texto disponible.
   • Para Linux - /etc/onlyoffice/documentserver/local.json
   • Para Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json
   • Para Docker – entra en el contenedor de ONLYOFFICE Docs usando el comando docker exec -it <containerID> bash y abre /etc/onlyoffice/documentserver/local.json

     Alternativamente, puedes usar el siguiente comando para encontrar la clave secreta predeterminada sin abrir local.json:

     sudo docker exec <containerID> /var/www/onlyoffice/documentserver/npm/json -f /etc/onlyoffice/documentserver/local.json 'services.CoAuthoring.secret.session.string'

   El archivo local.json debería verse así:

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

2. El valor true está especificado en tres secciones. Esto significa que la validación del token está habilitada.
   • services.CoAuthoring.token.enable.browser
   • services.CoAuthoring.token.enable.request.inbox
   • services.CoAuthoring.token.enable.request.outbox
3. La clave secreta generada automáticamente está especificada en tres secciones. Puedes reemplazar el valor secreto predeterminado con tu propia clave secreta. La clave secreta debe ser la misma en las tres secciones.
   • services.CoAuthoring.secret.inbox.string
   • services.CoAuthoring.secret.outbox.string
   • services.CoAuthoring.secret.session.string
4. Si realizas cambios, guárdalos y reinicia los servicios para que los cambios de configuración surtan efecto.
   • Para Linux:

     sudo supervisorctl restart all

   • Para Docker:

     docker exec <containerID> supervisorctl restart all

     o reinicia todo el contenedor:

     docker restart <containerID>

Paso 2: Especifica la misma clave secreta en la configuración del conector

En la configuración del conector, especifica la misma clave secreta en el campo Clave secreta y guarda los ajustes.