Liferay

Requisiti

• ONLYOFFICE Document Server v6.1.0 (server o versione cloud) o successiva.

  Hai bisogno di un'istanza di ONLYOFFICE Docs che sia risolvibile e connettibile sia da Liferay che da qualsiasi client finale. Deve essere in grado di inviare POST direttamente a Liferay.

  Si prega di fare riferimento alla pagina di documentazione ufficiale per ulteriori informazioni sull'installazione di 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.
• ONLYOFFICE Connector v2.2.0 per Liferay.

Installazione del Connettore ONLYOFFICE per Liferay

Puoi installare il connettore ONLYOFFICE utilizzando il Gestore App.

Per installarlo utilizzando il Gestore App:

1. Vai a Pannello di Controllo > Sistema > Gestore App.
2. Clicca il pulsante Opzioni.
3. Clicca il pulsante Carica.
4. Nella finestra aperta, scegli il file dell'applicazione ONLYOFFICE.

Quando l'installazione è completata, l'applicazione è pronta per l'uso.

Se stai costruendo il connettore da solo, basta posizionare il file compilato .jar dalla cartella build\libs in /opt/liferay/deploy. Liferay lo installerà automaticamente.

Compilazione del Connettore ONLYOFFICE per Liferay

Basta eseguire gradle build. L'output .jar verrà posizionato nella directory build/libs.

Configurazione del connettore ONLYOFFICE per Liferay

Vai a Pannello di Controllo > Configurazione > Impostazioni di Sistema. Nella sezione Piattaforma, scegli la categoria Connettori e seleziona ONLYOFFICE.

Qui puoi configurare le seguenti impostazioni:

• Indirizzo ONLYOFFICE Docs - specifica l'indirizzo URL dove è installato il Servizio di Modifica Documenti.
  L'indirizzo di ONLYOFFICE Docs deve essere accessibile da Liferay, così come l'indirizzo di Liferay deve essere accessibile da ONLYOFFICE Docs.
• Indirizzo ONLYOFFICE Docs per richieste interne dal server - specifica l'indirizzo utilizzato per accedere al Servizio di Modifica Documenti da Liferay.
• Indirizzo del server per richieste interne da ONLYOFFICE Docs - specifica l'indirizzo utilizzato per accedere a Liferay dal Servizio di Modifica Documenti.
• Chiave segreta - specifica la chiave segreta utilizzata per firmare i dati.
  A partire da ONLYOFFICE Docs v7.2, JWT è abilitato di default e la chiave segreta è generata automaticamente. Devi abilitarlo anche sul lato Liferay: 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, consulta la sezione Abilitazione JWT per l'integrazione di ONLYOFFICE e Liferay di questo articolo.
• Intestazione di autorizzazione (lascia vuoto per usare 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.
• Abilita Salvataggio Forzato - attiva la casella di controllo per mantenere versioni intermedie del documento durante la modifica.
• Abilita Anteprima Web ONLYOFFICE - attiva la casella di controllo per abilitare l'anteprima dei file.

Dopo aver configurato l'applicazione di integrazione, clicca il pulsante Salva per applicare le modifiche.

Come funziona

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

1. L'utente naviga nella sezione Documenti e Media all'interno di Liferay e seleziona l'azione Modifica in ONLYOFFICE.
2. Liferay prepara un oggetto JSON per il Document Server con le seguenti proprietà:
   • url: l'URL che ONLYOFFICE Docs utilizza per scaricare il documento;
   • callbackUrl: l'URL che ONLYOFFICE Docs utilizza per informare sullo stato della modifica del documento;
   • key: l'fileVersionId per istruire ONLYOFFICE Docs se scaricare nuovamente il documento o meno;
   • title: il titolo del documento (nome).
3. Il browser del client effettua una richiesta alla libreria JavaScript di ONLYOFFICE Docs e invia a ONLYOFFICE Docs la configurazione di DocEditor con le proprietà sopra indicate.
4. Quindi ONLYOFFICE Docs scarica il documento da Liferay e l'utente inizia a modificarlo.
5. ONLYOFFICE Docs invia una richiesta POST a callbackUrl per informare Liferay che un utente sta modificando il documento.
6. Liferay blocca il documento, ma consente comunque ad altri utenti con accesso in scrittura di collaborare in tempo reale con ONLYOFFICE Docs lasciando presente l'Azione.
7. Quando tutti gli utenti e i browser client hanno terminato la modifica, chiudono la finestra di modifica.
8. Dopo 10 secondi di inattività, ONLYOFFICE Docs invia un POST a callbackUrl informando Liferay che i client hanno terminato la modifica del documento e lo hanno chiuso.
9. Liferay scarica una nuova versione del documento, sostituendo quella vecchia.

Abilitazione JWT per l'integrazione di ONLYOFFICE e Liferay

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 di Documenti viene inizializzato e durante lo scambio di comandi tra i servizi interni di ONLYOFFICE Docs. La chiave segreta viene utilizzata per firmare il JSON web token e convalidare il token alla richiesta a ONLYOFFICE Docs.

A partire da ONLYOFFICE Docs v7.2, JWT è abilitato di default e la chiave segreta è 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 di configurazione abbiano effetto.
   • Per Linux:

     sudo supervisorctl restart all

   • Per Docker:

     docker exec <containerID> supervisorctl restart all

     o riavvia l'intero container:

     docker restart <containerID>

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.