Jira

Agregar el conector desde el marketplace de Atlassian

1. Inicia sesión en tu instancia de Jira Software como administrador.
2. Haz clic en el icono de Administración en la esquina superior derecha y elige la opción Gestionar aplicaciones del menú.
   
3. Se abrirá la sección Buscar nuevas aplicaciones. Haz clic en el campo Buscar en el Marketplace y encuentra la aplicación de integración Jira ONLYOFFICE.
4. Haz clic en el botón Instalar para descargar e instalar la aplicación.

Agregar el conector compilado desde el código fuente

Primero, necesitas instalar los siguientes requisitos previos para poder compilar el conector de ONLYOFFICE para Jira:

• 1.8.X del Oracle Java SE Development Kit 8
• Atlassian Plugin SDK

Para compilar el conector de ONLYOFFICE para Jira, sigue estos pasos:

1. Clona el repositorio onlyoffice-jira.

   git clone https://github.com/ONLYOFFICE/onlyoffice-jira.git

2. Ve al directorio onlyoffice-jira.

   cd onlyoffice-jira

3. Ejecuta el siguiente comando:

   atlas-package

   Espera mientras se compila el conector. Después de eso, el conector se encontrará en la carpeta target.

Puedes cargar el conector compilado en tu página de Administración de Jira Software > Gestionar aplicaciones.

1. Inicia sesión en tu instancia de Jira Software como administrador.
2. Haz clic en el icono de Administración en la esquina superior derecha y elige la opción Gestionar aplicaciones del menú.
3. Selecciona la sección Gestionar aplicaciones en el lado izquierdo de la página.
4. Haz clic en el enlace Subir aplicación.
5. Haz clic en el botón Elegir archivo, busca el archivo compilado target/onlyoffice-jira-app.jar y haz clic en Subir. Espera mientras se instala la aplicación.
   

Configuración del conector de ONLYOFFICE para Jira

Haz clic en el botón Configurar debajo de la aplicación de integración Jira ONLYOFFICE instalada en la página Gestionar aplicaciones o encuentra la aplicación en la sección OTRAS de la página Gestionar aplicaciones.

En el campo Dirección del servicio de edición de documentos, especifica la dirección IP o el nombre del host del servidor con ONLYOFFICE Docs instalado.

Desactivar la verificación de certificado (inseguro) - marca esta casilla para desactivar la verificación del certificado y permitir que Jira establezca una conexión con ONLYOFFICE Docs si estás utilizando un certificado autofirmado para tu ONLYOFFICE Docs (de lo contrario, Jira no validará un certificado autofirmado y no permitirá una conexión hacia/desde ONLYOFFICE Docs). Esta es una solución insegura, y recomendamos encarecidamente que reemplaces el certificado por uno emitido por una CA.

Especifica una Clave secreta - el secreto para validar el token web JSON al realizar la solicitud a ONLYOFFICE Docs.

La sección Configuraciones avanzadas del servidor puede usarse si tu configuración de red no permite solicitudes entre el Jira Software y ONLYOFFICE Docs instalados usando las direcciones públicas. En este caso, especifica direcciones para solicitudes internas en los campos correspondientes:

• Dirección del servidor de Jira Software para solicitudes internas desde ONLYOFFICE Docs.
• Dirección de ONLYOFFICE Docs para solicitudes internas desde el servidor de Jira Software.

Haz clic en Guardar para guardar la configuración.

Cómo funciona

La API documentada aquí o se basa en la API documentada aquí.

1. Un usuario navega a los adjuntos de Jira y selecciona la acción Editar en ONLYOFFICE.
2. Jira realiza una solicitud a OnlyOfficeEditorServlet (URL del formulario: /plugins/servlet/onlyoffice/doceditor?attachmentId=$attachment.id).
3. Jira envía el documento al servicio de almacenamiento de documentos de ONLYOFFICE y recibe un enlace temporal.
4. Jira prepara un objeto JSON con las siguientes propiedades:
   • url: el enlace temporal 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;
   • docserviceApiUrl: la URL a la que el cliente necesita responder a ONLYOFFICE Docs (proporcionada por la propiedad files.docservice.url.api);
   • key: el UUID para instruir a ONLYOFFICE Docs si debe descargar el documento nuevamente o no;
   • title: el título del documento (nombre).
5. Jira toma este objeto y construye una página a partir de una plantilla freemarker, completar todos esos valores para que el navegador del cliente pueda cargar el editor.
6. 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 anteriores.
7. Luego, ONLYOFFICE Docs descarga el documento del almacenamiento de documentos y el usuario comienza a editar.
8. Cuando todos los usuarios y navegadores de clientes han terminado de editar, cierran la ventana de edición.
9. Después de 10 segundos de inactividad, ONLYOFFICE Docs envía un POST a callbackUrl informando a Jira que los clientes han terminado de editar el documento y lo han cerrado.
10. El documento con todos los cambios se guarda como un nuevo adjunto con el sufijo agregado al nombre del archivo.

Habilitar JWT para la integración de ONLYOFFICE y Jira

Para proteger los documentos del acceso no autorizado, los editores de ONLYOFFICE utilizan el Token Web JSON (JWT). El token se agrega 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 la solicitud 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 – ingresa al 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 de tokens 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.

   supervisorctl restart all

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

En la configuración del conector, especifica el mismo secreto en el campo Clave secreta y guarda la configuración.

Conectar al servidor de demostración de ONLYOFFICE Docs

A partir de la versión 2.0.0 del conector de ONLYOFFICE, puedes probar los editores en línea de ONLYOFFICE dentro de Jira sin instalar ONLYOFFICE Docs.

Para activar la conexión, marca la casilla Conectar al servidor de demo de ONLYOFFICE Docs y haz clic en el botón Guardar.