IT
Accedi Crea un account

Come installare Wiki.js su Saplo (documentazione aziendale)

Wiki.js è una base di conoscenza open source con editor Markdown/WYSIWYG, versioning delle pagine e motore di ricerca. Ti mostriamo come installarla sul tuo Box e organizzare la documentazione del team.

Grzegorz Kalmus ·

Istruzioni per l'onboarding di nuovi dipendenti su Google Docs, procedure in file Word inviati via email, password del server in un blocco note che solo una persona possiede: ogni azienda in crescita, prima o poi, si imbatte in questo caos. Wiki.js è una base di conoscenza open source con editor Markdown e WYSIWYG, controllo delle versioni delle pagine e un motore di ricerca integrato, che puoi ospitare sul tuo Box invece di pagare per un altro account cloud. Di seguito, passo dopo passo, ti mostriamo come installare Wiki.js su Saplo.

Perché Wiki.js per la documentazione aziendale

I documenti sparsi su dischi, email e quaderni privati presentano lo stesso insieme di problemi: mancanza di un unico luogo dove un nuovo dipendente possa trovare le istruzioni da solo, invece di chiedere ai colleghi "dov'è"; mancanza di cronologia delle modifiche, perché un file Word sovrascritto da una seconda versione non dice chi e quando ha modificato il contenuto né perché; e zero ricerca significativa, perché in una pila di file sul disco cerchi per nome, non per il contenuto del documento. Wiki.js mantiene tutte le pagine in un unico posto, con una cronologia completa delle modifiche di ogni pagina (puoi tornare a qualsiasi versione) e un motore di ricerca che funziona in base al contenuto, non solo al titolo. Le aziende che desiderano lo stesso in una versione ospitata pagano per Confluence di Atlassian, dove la licenza per un piccolo team può costare circa 25 € al mese, e questo prima di aggiungere spazio extra per gli allegati. La base di conoscenza su Wiki.js si trova sul tuo Box, senza costi aggiuntivi per un nuovo account, senza limiti al numero di pagine e senza una fattura mensile che aumenta con il numero di persone nel team.

Wiki.js o BookStack, quale scegliere

Nel catalogo delle applicazioni Saplo, accanto a Wiki.js, trovi anche BookStack ed entrambi gli strumenti risolvono lo stesso problema, ma organizzano il contenuto in modo diverso. Wiki.js ti permette di costruire un albero arbitrario di pagine e sottopagine, quindi è adatto per le aziende che hanno molti argomenti vagamente correlati: procedure, politiche, note di progetto, documentazione tecnica. BookStack impone una struttura più rigida: Scaffale, Libro, Capitolo, Pagina, il che può essere più conveniente quando la documentazione ha una suddivisione predefinita, ad esempio un libro separato per ogni reparto aziendale. Wiki.js richiede un proprio container PostgreSQL e un minimo di 1 GB di RAM, BookStack utilizza il database MySQL condiviso di Saplo e parte già con 512 MB di RAM, quindi su un Box più piccolo rimangono più risorse per altre applicazioni. Se non sei sicuro su quale scegliere, inizia con Wiki.js, perché la sua struttura più libera cresce più facilmente con l'azienda, mentre BookStack sarà più adatto se sai già in anticipo come deve essere la suddivisione della documentazione.

Requisiti

Per installare Wiki.js su Saplo, hai bisogno di un Box con Docker in esecuzione (il motore lo abilita automaticamente durante l'installazione dal catalogo, è richiesto il nesting nel container, che Saplo ha di default), un minimo di 1 GB di RAM e 2 GB di spazio libero su disco sul Box, e un dominio o sottodominio *.saploapp.pl, che è incluso nel prezzo di ogni piano. Wiki.js, come Paperless-ngx o Baserow, non utilizza il database condiviso di Saplo. Richiede PostgreSQL, quindi la ricetta installa un proprio container di database accanto all'applicazione, il che significa che l'installazione non richiede alcun database separato dal catalogo o una configurazione manuale della connessione.

Installazione passo dopo passo

  1. Nel Pannello Saplo, vai su Catalogo delle applicazioni e seleziona Wiki.js (categoria "Business").
  2. Indica il Box su cui vuoi installarlo e il dominio o sottodominio dove sarà disponibile la knowledge base.
  3. Conferma l'installazione. Il motore installa due container Docker: l'immagine ufficiale ghcr.io/requarks/wiki e un proprio PostgreSQL per i dati, quindi espone il pannello sul dominio specificato tramite nginx con un certificato SSL gratuito.
  4. Una volta completato, il dominio risponderà con la procedura guidata di primo avvio di Wiki.js.

Primo avvio

A differenza di Paperless-ngx o Listmonk, dove l'account amministratore viene generato automaticamente all'installazione, Wiki.js funziona esattamente come n8n: crei manualmente l'account nel wizard al primo accesso alla pagina, senza un file di password nella directory dell'applicazione. Accedi al dominio indicato, il wizard ti chiederà l'e-mail dell'amministratore, la password e il nome del sito. Dopo aver creato l'account, verrai reindirizzato direttamente al pannello di amministrazione, dove potrai aggiungere altri utenti per il resto del team nella sezione Amministrazione -> Utenti. Ogni utente riceve il proprio login, quindi è sempre visibile chi ha modificato per ultimo una determinata pagina, il che distingue Wiki.js da un disco condiviso, dove l'autore della modifica deve essere indovinato.

Scrittura e organizzazione delle pagine

Puoi creare una nuova pagina cliccando il pulsante Nuova pagina, scegliendo un editor Markdown o WYSIWYG (un editor visuale che non richiede conoscenze di sintassi). Puoi passare da uno all'altro in qualsiasi momento senza perdere il contenuto. Le pagine sono organizzate in una struttura ad albero di cartelle, ad esempio "Implementazione", "Procedure", "Accessi", in modo che la struttura della documentazione rifletta la struttura dell'azienda, invece di essere un elenco piatto di titoli. Ogni modifica a una pagina viene salvata nella cronologia delle versioni; nella scheda Cronologia puoi vedere tutti i contenuti precedenti e ripristinare qualsiasi versione con un solo clic. Questo è utile se qualcuno sovrascrive accidentalmente una parte di una procedura. Il motore di ricerca nella barra superiore cerca il contenuto di tutte le pagine, non solo i titoli, quindi un frammento di frase è sufficiente per trovare l'istruzione corretta, anche se non ricordi il nome esatto della pagina.

Autorizzazioni e lavoro di squadra

Non tutte le pagine devono essere visibili a tutta l'azienda, per questo Wiki.js permette di assegnare le autorizzazioni a due livelli: gruppi di utenti e singole pagine. Nella sezione Amministrazione -> Gruppi crei gruppi corrispondenti ai reparti, ad esempio "Dirigenza", "Reparto tecnico", "Commerciale", e assegni loro le autorizzazioni di lettura, modifica o gestione di rami specifici dell'albero delle pagine. In questo modo, solo il reparto tecnico può vedere le password del server, mentre la politica sulle ferie è aperta a tutti, senza dover mantenere due sistemi separati. L'aggiunta di un nuovo dipendente si riduce alla creazione di un account e all'assegnazione al gruppo appropriato, anziché all'invio manuale di link a file sparsi sui dischi condivisi.

Backup ed esportazione dei contenuti

Wiki.js conserva i dati in un container PostgreSQL, quindi il backup funziona esattamente come per qualsiasi altra applicazione su Saplo, includendo sia i file che il database. Sui piani Box L e superiori, il backup viene creato automaticamente ogni giorno, mentre su Box S e M il backup è disponibile come servizio aggiuntivo a pagamento. Puoi eseguire un backup manuale in qualsiasi momento nel Pannello, nella sezione Backup, indipendentemente dall'automazione, ad esempio subito prima di una riorganizzazione significativa della struttura delle pagine. Il ripristino da un backup riporta l'applicazione allo stato in cui si trovava al momento della sua creazione, un aspetto da tenere a mente prima di testare modifiche rischiose su una base di conoscenza in produzione. Inoltre, Wiki.js consente di esportare singole pagine in file Markdown direttamente dall'editor, il che significa che puoi estrarre frammenti di documentazione al di fuori del pannello senza dover eseguire un backup completo dell'intera applicazione.

Wiki.js su Saplo contro i file sparsi sui dischi

File su disco/nelle email Wiki.js su Saplo
Posizione della documentazione sparsi, ognuno li tiene a modo suo un unico posto, condiviso per il team
Cronologia delle modifiche nessuna, il file sovrascritto scompare per sempre cronologia completa di ogni pagina, possibilità di annullare
Ricerca per nome del file per contenuto dell'intera pagina
Accesso del team condivisione manuale, senza controllo account e permessi per utente e gruppo
Dove sono i dati disco locale o cloud di terzi il tuo Box
Costo di un account aggiuntivo dipende dal piano cloud o dalla licenza Confluence incluso nel prezzo del piano Saplo

Domande frequenti

Wiki.js ha un editor WYSIWYG, o devo conoscere il markdown? Entrambi. Per ogni nuova pagina puoi scegliere un editor markdown o un editor visivo WYSIWYG senza conoscere la sintassi, e puoi anche passare da uno all'altro mentre scrivi la stessa pagina.

Dove trovo le credenziali di accesso dopo l'installazione? Creerai l'account amministratore da solo con l'installazione guidata la prima volta che accedi al dominio. Wiki.js non genera una password predefinita come Paperless-ngx.

Le pagine hanno una cronologia delle modifiche? Sì, ogni modifica viene aggiunta alla cronologia delle versioni della pagina, con la possibilità di visualizzare e ripristinare qualsiasi versione precedente.

Posso limitare l'accesso a pagine selezionate? Sì, Wiki.js consente di assegnare autorizzazioni a livello di gruppo e di singola pagina, in modo che, ad esempio, solo il reparto tecnico possa vedere gli accessi ai server.

In che modo Wiki.js è diverso da BookStack? Wiki.js offre un albero di pagine flessibile e richiede il proprio PostgreSQL, mentre BookStack impone una struttura di Scaffale/Libro/Capitolo e utilizza un database MySQL Saplo condiviso, quindi può essere avviato su un Box più piccolo. Entrambi sono disponibili nel catalogo delle applicazioni.

Posso avere Wiki.js e un'altra applicazione su un unico Box? Sì, ogni piano ha un numero illimitato di applicazioni; i soli limiti sono la RAM e il disco del Box.

Se hai domande sull'installazione di Wiki.js sul tuo Box o sull'organizzazione della documentazione del team, scrivici, ti aiuteremo con la configurazione iniziale.

  • #Base di conoscenza
  • #Documentazione
  • #Guida
  • #Lavoro di squadra
  • #Wiki.js