Jira

Agregar el conector desde Atlassian Marketplace

1. Inicia sesión en tu instancia de Jira Software como administrador.
2. Haz clic en el icono Administración en la esquina superior derecha y selecciona la opción Gestionar apps del menú.
   
3. Se abrirá la sección Buscar nuevas apps. Haz clic en el campo Buscar en Marketplace y encuentra la app 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 prerrequisitos para poder compilar el conector ONLYOFFICE para Jira:

• Java SE Development Kit 8 versión 1.8.X de Oracle
• Atlassian Plugin SDK

Para compilar el conector 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, el conector estará en la carpeta target.

Puedes subir el conector compilado en la página Administración de Jira Software > Gestionar apps.

1. Inicia sesión en tu instancia de Jira Software como administrador.
2. Haz clic en el icono Administración en la esquina superior derecha y selecciona la opción Gestionar apps del menú.
3. Selecciona la sección Gestionar apps en el lado izquierdo de la página.
4. Haz clic en el enlace Subir app.
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.
   

Configurar el conector ONLYOFFICE para Jira

Haz clic en el botón Configurar debajo de la app instalada Jira ONLYOFFICE integration app en la página Gestionar apps o encuentra la app en la sección OTRAS de la página Gestionar apps.

Document Server

1. En el campo Dirección del servicio de edición de documentos, especifica la dirección IP o el nombre del host del servidor donde está instalado ONLYOFFICE Docs.
   La dirección de ONLYOFFICE Docs debe ser accesible desde Jira, así como la dirección de Jira debe ser accesible desde ONLYOFFICE Docs.
2. Deshabilitar verificación de certificado (inseguro) — marca esta casilla para deshabilitar la verificación del certificado y permitir que Jira establezca conexión con ONLYOFFICE Docs si usas un certificado autofirmado. Esta es una solución insegura; recomendamos encarecidamente reemplazar el certificado por uno emitido por una CA.
3. Especifica una Clave secreta (deja en blanco para deshabilitar) — el secreto para validar el token web JSON en 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. Debes habilitarlo también en el lado de Jira: encuentra tu clave secreta en el archivo de configuración de ONLYOFFICE Docs y luego especifica la misma clave secreta en la configuración del conector. Para más detalles, consulta la sección Habilitar JWT de este artículo.
4. Encabezado de autorización (deja en blanco para usar el encabezado predeterminado) — el encabezado JWT de autorización usado en ONLYOFFICE es Authorization. Si este encabezado entra en conflicto con tu configuración, puedes cambiarlo por uno personalizado.
5. Conectar al servidor de demostración de ONLYOFFICE Document Server — inicia un servidor de prueba.
   ImportanteEste es un servidor público de prueba que estará disponible durante un período de 30 días. No compartas tus datos sensibles allí.

Configuración avanzada del servidor

La sección Configuración avanzada del servidor puede usarse si la configuración de tu red no permite solicitudes entre Jira Software y ONLYOFFICE Docs usando direcciones públicas. Especifica direcciones para solicitudes internas en los campos correspondientes:

1. Dirección del servidor para solicitudes internas desde el Servicio de edición de documentos — dirección del servidor Jira Software para solicitudes internas desde ONLYOFFICE Docs.
2. Dirección del Servicio de edición de documentos para solicitudes internas desde el servidor — dirección de ONLYOFFICE Docs para solicitudes internas desde el servidor Jira Software.

Configuración común

1. Formatos editables — marca la casilla junto a los formatos que son compatibles con tu entorno Jira.

   Puede ocurrir pérdida de datos al guardar en los formatos especificados debido a restricciones del formato.

2. Interfaz del editor — personaliza la interfaz de los editores:
   • Mostrar botón del menú Chat — ocultar/mostrar el icono de Chat integrado en línea en el panel izquierdo.
   • Mostrar encabezado más compacto — ocultar/mostrar texto de iconos en la barra de herramientas superior.
   • Mostrar botón del menú Feedback & Support — ocultar/mostrar el botón Feedback & Support en el panel izquierdo.
   • Mostrar botón del menú Ayuda — ocultar/mostrar el botón Ayuda en el panel izquierdo.
   • Mostrar encabezado de barra de herramientas monocromático — cambiar la barra de herramientas superior a una paleta de colores monocromática.

Seguridad

1. Habilitar plugins — habilitar/deshabilitar soporte de plugins para los editores.
2. Ejecutar macros de documentos — habilitar/deshabilitar la ejecución de macros dentro de los editores.
3. Habilitar protección de documentos para — elige si deseas permitir que todos los usuarios habiliten la protección con contraseña para los documentos, o solo el propietario del documento.

Haz clic en Guardar para guardar la configuración.

Cómo funciona

La integración ONLYOFFICE sigue la API documentada aquí.

1. Un usuario navega a los archivos adjuntos de Jira y selecciona la acción Editar en ONLYOFFICE.
2. Jira realiza una solicitud a OnlyOfficeEditorServlet (URL de la forma: /plugins/servlet/onlyoffice/doceditor?attachmentId=$attachment.id).
3. Jira envía el documento al servicio de almacenamiento de documentos ONLYOFFICE y recibe un enlace temporal.
4. Jira prepara un objeto JSON con las siguientes propiedades:
   • url: el enlace temporal que ONLYOFFICE Docs usa para descargar el documento;
   • callbackUrl: la URL que ONLYOFFICE Docs usa para informar sobre el estado de la edición del documento;
   • docserviceApiUrl: la URL a la que el cliente debe responder a ONLYOFFICE Docs (proporcionada por la propiedad files.docservice.url.api);
   • key: el UUID para indicar a ONLYOFFICE Docs si debe descargar el documento nuevamente o no;
   • title: el título (nombre) del documento.
5. Jira toma este objeto y construye una página a partir de una plantilla freemarker, llenando todos esos valores para que el navegador del cliente pueda cargar el editor.
6. El navegador del cliente hace 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 y el usuario comienza a editar.
8. Cuando todos los usuarios y navegadores clientes terminan 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 archivo adjunto con un sufijo añadido al nombre del archivo.

Habilitar JWT

Para proteger los documentos del acceso no autorizado, los editores ONLYOFFICE usan JSON Web Token (JWT). El token se añade en 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 usa para firmar el token web JSON y validar el token en 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. Debes encontrar tu clave secreta en el archivo de configuración de ONLYOFFICE Docs y luego especificar 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, lo que 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 predeterminado con tu propia clave secreta — debe ser la misma en las tres:
   • services.CoAuthoring.secret.inbox.string
   • services.CoAuthoring.secret.outbox.string
   • services.CoAuthoring.secret.session.string
4. Si haces cambios, guárdalos y reinicia los servicios:

   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 con la demo de ONLYOFFICE Docs

A partir de la versión 2.0.0 del conector 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 demostración de ONLYOFFICE Docs y haz clic en el botón Guardar.