Jira

Aggiungere il connettore dall'Atlassian Marketplace

1. Accedi alla tua istanza di Jira Software come amministratore.
2. Clicca sull'icona Amministrazione nell'angolo in alto a destra e scegli l'opzione Gestisci app dal menu.
   
3. Si aprirà la sezione Trova nuove app. Clicca sul campo Cerca nel Marketplace e trova l'app di integrazione Jira ONLYOFFICE.
4. Clicca sul pulsante Installa per scaricare e installare l'applicazione.

Aggiungere il connettore compilato dal codice sorgente

Prima di tutto, devi installare i seguenti prerequisiti per poter compilare il connettore ONLYOFFICE per Jira:

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

Per compilare il connettore ONLYOFFICE per Jira, segui questi passaggi:

1. Clona il repository onlyoffice-jira.

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

2. Vai nella directory onlyoffice-jira.

   cd onlyoffice-jira

3. Esegui il seguente comando:

   atlas-package

   Attendi mentre il connettore viene compilato. Dopo di che, il connettore può essere trovato nella cartella target.

Puoi caricare il connettore compilato sulla tua pagina Amministrazione Jira Software > Gestisci app.

1. Accedi alla tua istanza di Jira Software come amministratore.
2. Clicca sull'icona Amministrazione nell'angolo in alto a destra e scegli l'opzione Gestisci app dal menu.
3. Seleziona la sezione Gestisci app sul lato sinistro della pagina.
4. Clicca sul link Carica app.
5. Clicca sul pulsante Scegli File, cerca il file compilato target/onlyoffice-jira-app.jar e clicca su Carica. Attendi mentre l'applicazione viene installata.
   

Configurazione del connettore ONLYOFFICE per Jira

Clicca sul pulsante Configura sotto l'app di integrazione Jira ONLYOFFICE installata nella pagina Gestisci app o trova l'app nella sezione ALTRO della pagina Gestisci app.

Document Server

1. Nel campo Indirizzo del servizio di modifica documenti, specifica l'indirizzo IP o il nome host del server con ONLYOFFICE Docs installato.
   L'indirizzo di ONLYOFFICE Docs deve essere accessibile da Jira, così come l'indirizzo di Jira deve essere accessibile da ONLYOFFICE Docs.
2. Disabilita la verifica del certificato (non sicuro) - seleziona questa casella per disabilitare la verifica del certificato e consentire a Jira di stabilire una connessione con ONLYOFFICE Docs se stai utilizzando un certificato autofirmato per il tuo ONLYOFFICE Docs (altrimenti, Jira non convaliderà un certificato autofirmato e non consentirà una connessione a/da ONLYOFFICE Docs). Questa è una soluzione non sicura e ti consigliamo vivamente di sostituire il certificato con uno emesso da un'autorità di certificazione.
3. Specifica una Chiave segreta (lascia vuoto per disabilitare) - il segreto per convalidare il token web JSON su richiesta a ONLYOFFICE Docs.
   A partire da ONLYOFFICE Docs v7.2, JWT è abilitato per impostazione predefinita e la chiave segreta viene generata automaticamente. Devi abilitarlo anche sul lato Jira: trova la tua chiave segreta nel file di configurazione di ONLYOFFICE Docs, quindi specifica la stessa chiave segreta nelle impostazioni del connettore. Per ulteriori dettagli, vedi la sezione Abilitare JWT per l'integrazione di ONLYOFFICE e Jira di questo articolo.
4. Intestazione di autorizzazione (lascia vuoto per utilizzare l'intestazione predefinita) - l'intestazione JWT di autorizzazione utilizzata in ONLYOFFICE è Authorization. Nel caso in cui questa intestazione sia in conflitto con la tua configurazione, puoi cambiarla con una personalizzata.
5. Connetti al server demo di ONLYOFFICE Document - avvia un server di prova.
   ImportanteQuesto è un server di prova pubblico che sarà disponibile per un periodo di 30 giorni. Non condividere i tuoi dati sensibili lì.

Impostazioni avanzate del server

La sezione Impostazioni avanzate del server può essere utilizzata se la tua configurazione di rete non consente richieste tra il Jira Software installato e ONLYOFFICE Docs utilizzando gli indirizzi pubblici. In questo caso, specifica gli indirizzi per le richieste interne nei campi corrispondenti:

1. Indirizzo del server per le richieste interne dal servizio di modifica documenti - indirizzo del server Jira Software per le richieste interne da ONLYOFFICE Docs
2. Indirizzo del servizio di modifica documenti per le richieste interne dal server - indirizzo di ONLYOFFICE Docs per le richieste interne dal server Jira Software

Impostazioni comuni

1. Formati modificabili - seleziona la casella accanto ai formati supportati dal tuo ambiente Jira.

   La perdita di dati può verificarsi quando si salva nei formati specificati a causa delle restrizioni del formato.

2. Interfaccia dell'editor - personalizza l'interfaccia degli editor:
   • Mostra pulsante menu Chat - nascondi/mostra l'icona della Chat integrata online nel pannello di sinistra.
   • Mostra l'intestazione più compatta - nascondi/mostra il testo dell'icona sulla barra degli strumenti superiore.
   • Mostra pulsante menu Feedback & Support - nascondi/mostra il pulsante Feedback & Support nel pannello di sinistra.
   • Mostra pulsante menu Aiuto - nascondi/mostra il pulsante Aiuto nel pannello di sinistra.
   • Mostra intestazione barra degli strumenti monocromatica - passa la barra degli strumenti superiore a una palette di colori monocromatica.

Sicurezza

1. Abilita plugin - abilita/disabilita il supporto dei plugin per gli editor.
2. Esegui macro documento - abilita/disabilita l'esecuzione delle macro all'interno degli editor.
3. Abilita protezione documento per - scegli se vuoi consentire a tutti gli utenti di abilitare la protezione con password per i documenti, o solo al proprietario del documento.

Clicca su Salva per salvare le impostazioni.

Come funziona

L'integrazione di ONLYOFFICE segue l'API documentata qui.

1. Un utente naviga agli allegati di Jira e seleziona l'azione Modifica in ONLYOFFICE.
2. Jira effettua una richiesta a OnlyOfficeEditorServlet (URL del tipo: /plugins/servlet/onlyoffice/doceditor?attachmentId=$attachment.id).
3. Jira invia il documento al servizio di archiviazione documenti di ONLYOFFICE e riceve un link temporaneo.
4. Jira prepara un oggetto JSON con le seguenti proprietà:
   • url: il link temporaneo che ONLYOFFICE Docs utilizza per scaricare il documento;
   • callbackUrl: l'URL che ONLYOFFICE Docs utilizza per informare sullo stato della modifica del documento;
   • docserviceApiUrl: l'URL a cui il client deve rispondere a ONLYOFFICE Docs (fornito dalla proprietà files.docservice.url.api);
   • key: l'UUID per istruire ONLYOFFICE Docs se scaricare nuovamente il documento o meno;
   • title: il titolo del documento (nome).
5. Jira prende questo oggetto e costruisce una pagina da un modello freemarker, riempiendo tutti quei valori in modo che il browser del client possa caricare l'editor.
6. Il browser del client effettua una richiesta alla libreria JavaScript di ONLYOFFICE Docs e invia a ONLYOFFICE Docs la configurazione DocEditor con le proprietà sopra.
7. Quindi ONLYOFFICE Docs scarica il documento dall'archiviazione documenti e l'utente inizia a modificarlo.
8. Quando tutti gli utenti e i browser dei client hanno terminato la modifica, chiudono la finestra di modifica.
9. Dopo 10 secondi di inattività, ONLYOFFICE Docs invia un POST a callbackUrl informando Jira che i client hanno terminato la modifica del documento e lo hanno chiuso.
10. Il documento con tutte le modifiche viene salvato come nuovo allegato con il postfisso aggiunto al nome del file.

Abilitare JWT per l'integrazione di ONLYOFFICE e Jira

Per proteggere i documenti da accessi non autorizzati, gli editor di ONLYOFFICE utilizzano il JSON Web Token (JWT). Il token viene aggiunto nella configurazione quando l'Editor Documenti viene inizializzato e durante lo scambio di comandi tra i servizi interni di ONLYOFFICE Docs. La chiave segreta viene utilizzata per firmare il token web JSON e convalidare il token su richiesta a ONLYOFFICE Docs.

A partire da ONLYOFFICE Docs v7.2, JWT è abilitato per impostazione predefinita e la chiave segreta viene generata automaticamente. Devi trovare la tua chiave segreta nel file di configurazione di ONLYOFFICE Docs, quindi specificare la stessa chiave segreta nelle impostazioni del connettore.

Passo 1: Trova la tua chiave segreta nel file di configurazione di ONLYOFFICE Docs

1. Apri il file local.json con qualsiasi editor di testo disponibile.
   • Per Linux - /etc/onlyoffice/documentserver/local.json
   • Per Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json
   • Per Docker – entra nel container di ONLYOFFICE Docs utilizzando il comando docker exec -it <containerID> bash e apri /etc/onlyoffice/documentserver/local.json

     In alternativa, puoi utilizzare il seguente comando per trovare la chiave segreta predefinita senza aprire local.json:

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

   Il file local.json dovrebbe apparire così:

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

2. Il valore true è specificato in tre sezioni. Significa che la convalida del token è abilitata.
   • services.CoAuthoring.token.enable.browser
   • services.CoAuthoring.token.enable.request.inbox
   • services.CoAuthoring.token.enable.request.outbox
3. La chiave segreta generata automaticamente è specificata in tre sezioni. Puoi sostituire il valore segreto predefinito con la tua chiave segreta. La chiave segreta deve essere la stessa in tre sezioni.
   • services.CoAuthoring.secret.inbox.string
   • services.CoAuthoring.secret.outbox.string
   • services.CoAuthoring.secret.session.string
4. Se apporti modifiche, salvale e riavvia i servizi affinché le modifiche alla configurazione abbiano effetto.

   supervisorctl restart all

Passo 2: Specifica la stessa chiave segreta nelle impostazioni del connettore

Nelle impostazioni del connettore, specifica lo stesso segreto nel campo Chiave segreta e salva le impostazioni.

Connessione al demo di ONLYOFFICE Docs

A partire dalla versione 2.0.0 del connettore ONLYOFFICE, puoi provare gli editor online di ONLYOFFICE all'interno di Jira senza installare ONLYOFFICE Docs.

Per attivare la connessione, seleziona la casella Connetti al server demo di ONLYOFFICE Docs e clicca sul pulsante Salva.