Come installare HedgeDoc su Saplo (collaborazione in tempo reale su documenti Markdown)

Prendere appunti di una riunione da parte di una persona mentre il resto del team aspetta o aggiunge commenti in una chat laterale è più lento che lavorare insieme sullo stesso documento in tempo reale. Notion e Dropbox Paper lo consentono, ma al costo di un account cloud di terze parti e di un abbonamento che cresce con il numero di persone nel team. HedgeDoc è un editor Markdown open source che permette a più persone di lavorare contemporaneamente sullo stesso documento, visualizzando i cursori e le modifiche degli altri in tempo reale, e l'intera configurazione può essere ospitata sul tuo Box. Di seguito ti spieghiamo passo dopo passo come installare HedgeDoc su Saplo.

Perché scegliere HedgeDoc invece di Notion o Dropbox Paper?

Gli strumenti a pagamento per la modifica collaborativa dei documenti hanno due caratteristiche che sono particolarmente fastidiose per i piccoli team e i freelance:

• Il prezzo aumenta con il numero di utenti - il piano gratuito di solito è sufficiente per una persona, ma aggiungere ogni collaboratore successivo al team in Notion o in uno strumento simile è una voce separata sulla fattura ogni mese.
• Il contenuto dei documenti si trova su un server di terze parti - gli appunti delle riunioni, i piani di progetto e le bozze di testo sono nelle mani di un'azienda esterna, non tue.

HedgeDoc funziona come un container Docker con il suo container PostgreSQL sul tuo Box, quindi il contenuto di tutti i documenti e la cronologia delle modifiche rimangono sulla tua infrastruttura, senza costi per persona e senza limiti al numero di documenti.

HedgeDoc e Trilium, oppure Wiki.js/BookStack: tre diverse nicchie di note nel catalogo Saplo

Nel catalogo Saplo sono già presenti Trilium Notes, Wiki.js e BookStack, quindi la domanda naturale è: in cosa HedgeDoc si differenzia da questi? La risposta sta nello scopo di ciascuno di questi strumenti:

• Trilium Notes è un blocco note personale - una base di note e conoscenze gerarchica, costruita da un singolo utente nel tempo, senza l'enfasi sull'editing dal vivo da parte di più persone contemporaneamente,
• Wiki.js e BookStack sono wiki aziendali con versioning delle pagine, struttura delle categorie e permessi - ottimi per documentazioni con una struttura fissa e una cronologia delle modifiche, ma non per una bozza rapida e collaborativa dal vivo,
• HedgeDoc si concentra esclusivamente sull'editing dal vivo e simultaneo di un singolo documento Markdown - vedi i cursori degli altri partecipanti e le loro modifiche in tempo reale, senza una struttura di base di conoscenza completa e senza un sistema di permessi come in una wiki aziendale.

Se stai creando una base di conoscenza personale, dai un'occhiata a Trilium. Se il tuo team ha bisogno di una documentazione strutturata con cronologia delle versioni, scegli Wiki.js o BookStack. Se si tratta di prendere appunti di riunione o di abbozzare un testo dal vivo, qui, ora, insieme a qualcuno, HedgeDoc è la soluzione migliore.

Requisiti

Per configurare HedgeDoc su Saplo, hai bisogno di:

• Un Box con Docker avviato (il motore lo abilita automaticamente durante l'installazione dalla directory, è richiesto il nesting nel container, che Saplo ha per impostazione predefinita),
• Minimo 1 GB di RAM libero sul Box e 2 GB di spazio su disco, quindi un piano Box M (65 €/anno) o superiore,
• Un dominio o sottodominio *.saploapp.pl incluso nel prezzo di ogni piano, dove sarà ospitato l'editor,
• Non devi creare manualmente un database separato - HedgeDoc richiede un database SQL, e il motore configura un container PostgreSQL dedicato nello stesso docker-compose (il database condiviso di Saplo supporta solo MySQL/MariaDB).

Installazione passo dopo passo

1. Nel pannello di controllo di Saplo, vai su Catalogo applicazioni e seleziona HedgeDoc (categoria "Business").
2. Seleziona il Box con almeno 1 GB di RAM libera su cui installare l'editor e il dominio o sottodominio su cui funzionerà.
3. Conferma l'installazione. Il motore crea un contenitore dall'immagine ufficiale quay.io/hedgedoc/hedgedoc insieme a un contenitore postgres:15-alpine dedicato, genera una password casuale per il database e un segreto di sessione casuale, quindi espone l'applicazione solo sul loopback del Box, collegato a nginx, che la serve sotto il dominio specificato con SSL gratuito. All'esterno viene esposta solo la porta 443, non la porta raw del contenitore.
4. Dopo docker compose up, il motore verifica inoltre se la pagina HedgeDoc risponde effettivamente via HTTP, poiché il primo avvio del contenitore esegue le migrazioni dello schema del database e può richiedere più dei tipici pochi secondi, quindi lo stato "contenitore in esecuzione" non significa ancora che l'applicazione sia pronta.
5. La modifica collaborativa funziona tramite websocket sullo stesso dominio dell'applicazione - non richiede alcuna configurazione aggiuntiva sul lato client né una porta separata.

Prima configurazione

HedgeDoc, a differenza di Directus o Wiki.js, non ha il concetto di account amministratore - chiunque si registri è un utente normale e vede solo i propri documenti e quelli a cui ha ricevuto un link.

1. Vai all'indirizzo del dominio, ad esempio notatki.saploapp.pl, e crea il primo account nel wizard di registrazione al primo accesso al sito.
2. Crea un nuovo documento con il pulsante New note - ottieni un link di modifica unico, che invii a chiunque debba partecipare al lavoro collaborativo sul contenuto.
3. I collaboratori aprono lo stesso link e vedono immediatamente i cursori e le modifiche degli altri in tempo reale, senza bisogno di creare un proprio account, se il documento ha accesso aperto alla modifica.
4. Esporta il documento pronto in PDF, HTML o file Markdown grezzo dal menu del documento, oppure condividilo ulteriormente in sola lettura con un link separato.
5. Puoi visualizzare la cronologia delle versioni del documento nella vista Revision, che ti permette di tornare a un contenuto precedente senza dover copiare manualmente i backup.

HedgeDoc su Saplo vs. Notion e Dropbox Paper

Domande frequenti

HedgeDoc ha bisogno di un database separato? Sì, a differenza di alcune applicazioni nella directory Saplo, HedgeDoc richiede un database SQL. Pertanto, il motore crea per esso un container PostgreSQL dedicato nello stesso docker-compose, non utilizzando il database Saplo condiviso disponibile solo per MySQL/MariaDB.

In che modo HedgeDoc è diverso da Trilium Notes, dato che entrambi sono nel catalogo Saplo? Trilium è un blocco note gerarchico per una singola persona, pensato per essere costruito nel tempo. HedgeDoc si concentra sull'editing simultaneo di un singolo documento da parte di più persone contemporaneamente, in tempo reale.

È necessario creare un account per modificare un documento insieme? No, se il documento ha accesso pubblico all'editing, basta un link. Creerai un account solo per avere un elenco dei tuoi documenti salvati in modo permanente.

È possibile esportare un documento finito al di fuori di HedgeDoc? Sì, dal menu del documento puoi esportare il contenuto in PDF, HTML o un file Markdown grezzo.

Se il tuo team scrive note e bozze insieme, in tempo reale, e cerca un editor semplice senza abbonamento per persona, scrivici, ti aiuteremo a scegliere il Box più adatto al tuo team.