Guida rapida per configurare il tuo wiki con Wiki.js in pochi minuti

Wiki.js è un’applicazione wiki open source ricca di funzionalità, progettata sul framework Node.js. Offre un’esperienza di editing versatile con supporto per interfacce Markdown e WYSIWYG. Inoltre, facilita la collaborazione in tempo reale, il controllo delle versioni e una varietà di metodi di autenticazione, tra cui l’integrazione con Google e LDAP. Questa guida completa ti guiderà attraverso i passaggi necessari per configurare Wiki.js utilizzando Docker, consentendoti di distribuire il tuo wiki in pochi minuti.

Impostazione di Wiki.js tramite Docker Compose

La procedura di configurazione di Wiki.js con Docker e Docker Compose è semplice. Inizia creando una nuova directory chiamata wikijs-dockere accedi al suo interno:

mkdir wikijs-docker && cd wikijs-docker

Successivamente, crea un file denominato docker-compose.ymlutilizzando il tuo editor di testo preferito:

nano docker-compose.yml

Quindi, inserisci la seguente configurazione nel file:

services: db: image: postgres:16 environment: POSTGRES_DB: wiki POSTGRES_PASSWORD: wikijsrocks POSTGRES_USER: wikijs restart: unless-stopped volumes: - db-data:/var/lib/postgresql/data wiki: image: ghcr.io/requarks/wiki:2 depends_on: - db environment: DB_TYPE: postgres DB_HOST: db DB_PORT: 5432 DB_USER: wikijs DB_PASS: wikijsrocks DB_NAME: wiki restart: unless-stopped ports: - "80:3000" volumes: db-data:

Dopo aver salvato e chiuso il file, avviare i contenitori eseguendo il seguente comando:

docker compose up -d

Una volta completata la configurazione, accedi a http://localhost nel tuo browser web. Qui dovrai fornire i dettagli dell’account amministratore e selezionare il pulsante Installa per avviare l’installazione:

Una volta completata l’installazione, accedi utilizzando le tue credenziali.

Creazione e gestione di pagine in Wiki.js

Una volta completata la configurazione iniziale, puoi creare la tua home page per iniziare a popolare i tuoi contenuti o accedere al pannello di amministrazione per gestire le tue impostazioni, gli utenti e le funzionalità disponibili:

Cliccando sull’opzione Crea home page, ti verrà chiesto di scegliere un editor adatto alle tue preferenze:

Successivamente, definisci le proprietà della tua pagina e premi il pulsante OK per procedere con la creazione di una nuova pagina:

Scrivi il contenuto desiderato e clicca sul pulsante Crea per finalizzare la creazione della pagina:

Gestione e organizzazione dei contenuti

La dashboard offre un modo pratico per visualizzare e modificare le pagine esistenti, nonché per crearne di nuove utilizzando l’editor che preferisci. Puoi organizzare i tuoi contenuti rinominando, spostando o eliminando le pagine e utilizzare i tag per una categorizzazione efficace. Inoltre, la barra laterale e la funzionalità di ricerca velocizzano la navigazione verso pagine specifiche all’interno del tuo wiki:

Configurazione delle impostazioni del sito Wiki.js

All’interno del pannello di amministrazione di Wiki.js, hai la flessibilità di configurare le impostazioni del sito come impostazioni locali, strutture di navigazione, temi e tag. Queste impostazioni svolgono un ruolo cruciale nel definire la configurazione complessiva della tua istanza di Wiki.js.

Nella scheda Generale puoi regolare le impostazioni fondamentali del sito, tra cui il titolo del sito, la descrizione, la home page predefinita e le impostazioni di visibilità (pubblica o privata):

Passa alla scheda Impostazioni locali per specificare la lingua predefinita, il fuso orario e i formati di data/ora per il tuo sito:

Per gestire la struttura del menu del tuo wiki e migliorare la navigazione dell’utente, visita la sezione Barra di navigazione :

Nella scheda Pagine puoi supervisionare, modificare e organizzare tutte le pagine wiki, creare nuove pagine e gestire la gerarchia dei tuoi contenuti:

Inoltre, nella scheda Tag, puoi creare e gestire tag di contenuto, migliorando la ricercabilità delle pagine. Puoi anche personalizzare gli elementi estetici del tuo wiki tramite la scheda Tema, dove puoi modificare il logo del sito, i colori, i font e gli stili di layout.

Gestione dei gruppi nel tuo wiki

La sezione Gruppi consente di creare gruppi di utenti, designare i membri e stabilire autorizzazioni a livello di gruppo per regolamentare l’accesso. Questo metodo organizzativo aiuta a semplificare i ruoli degli utenti e a mantenere una gestione coerente degli accessi in tutto il wiki.

Cliccando su un gruppo specifico è possibile aggiornarne le impostazioni, i permessi, le regole di pagina e la gestione degli utenti all’interno di quel gruppo. Tramite la scheda Impostazioni, è possibile modificare le opzioni, incluso l’URL di reindirizzamento all’accesso.

Puoi anche navigare tra le sezioni Autorizzazioni, Regole di pagina e Utenti per definire a cosa può accedere il gruppo e assegnare gli utenti di conseguenza.

Gestione degli utenti in Wiki.js

Per aggiungere un nuovo utente, vai alla sezione Utenti, clicca sul pulsante NUOVO UTENTE e compila i campi richiesti.

Una volta completato, seleziona CREA o CREA E CHIUDI per finalizzare la configurazione del nuovo utente:

Selezionando un utente specifico è possibile visualizzare e modificare il suo profilo, assegnare gruppi di utenti, definire metodi di autenticazione (come password o autenticazione a due fattori) e gestire il suo stato con azioni come Disattiva, Verifica o Elimina :

Inoltre, puoi aggiornare le loro informazioni di base, i metadati estesi (inclusi posizione e titolo professionale) e visualizzare la cronologia delle loro attività:

Gestire i moduli Wiki

I moduli sono miglioramenti che ampliano le funzionalità di Wiki.js. Ad esempio, il modulo Analytics consente di integrare strumenti come Google Analytics per monitorare il coinvolgimento degli utenti e le metriche del traffico:

Utilizzare la scheda Autenticazione per stabilire e gestire i provider di autenticazione (accesso locale, LDAP, OAuth) oltre a configurare varie opzioni di accesso:

Configurare le impostazioni di autenticazione

Puoi anche attivare o disattivare il sistema di commenti e stabilire in che modo gli utenti partecipano alle discussioni sulla pagina:

Configurazione del sistema

Gestisci il rendering, l’indicizzazione per la ricerca e l’archiviazione dei contenuti configurando i motori di rendering, l’indicizzazione per la ricerca e le impostazioni di archiviazione. Ad esempio, accedi alla scheda Rendering per personalizzare il rendering dei contenuti, ad esempio modificando le impostazioni del motore Markdown o abilitando il supporto per diagrammi ed espressioni matematiche:

Nella sezione Motore di ricerca puoi gestire le opzioni di indicizzazione della ricerca interna e le integrazioni con motori di ricerca di terze parti:

Nella sezione Archiviazione, specifica gli obiettivi di backup e sincronizzazione per i tuoi contenuti, consentendoti di gestire dove e come archiviare i file multimediali e gli allegati di pagina (ad esempio sul file system locale o su AWS S3):

Gestione della sicurezza e della connettività

Puoi proteggere la tua istanza Wiki.js configurando l’accesso alle API, impostando le notifiche email, modificando i criteri di sicurezza e abilitando SSL per un’esperienza sicura. Ad esempio, gestisci i token API per integrare Wiki.js con altre applicazioni:

Imposta le configurazioni e-mail per la gestione delle notifiche, degli inviti e dei processi di recupero password all’interno di Wiki.js:

È anche possibile perfezionare le impostazioni di sicurezza, coprendo aspetti quali timeout di sessione, criteri di password e restrizioni di accesso:

Impostazioni di sicurezza di configurazione

Inoltre, puoi impostare certificati SSL/TLS per garantire che la tua istanza Wiki.js funzioni in modo sicuro tramite HTTPS:

Inoltre, verifica le informazioni Wiki, come la diagnostica di sistema, le specifiche del server e le statistiche dell’ambiente di runtime, dalla sezione Informazioni di sistema :

Eseguire attività di manutenzione come la reindicizzazione dei risultati di ricerca, la cancellazione dei dati memorizzati nella cache o il ripristino delle configurazioni dalla scheda Utilità :

Infine, gli Strumenti per sviluppatori offrono risorse avanzate come l’area di lavoro GraphQL, funzionalità di debug dei log o integrazioni di script personalizzati:

Ora che hai le conoscenze necessarie per configurare Wiki.js utilizzando Docker, puoi usare questa piattaforma con sicurezza per creare documentazione interna, wiki collaborativi per team o knowledge base pubbliche senza alcuno sforzo.

Fonte e immagini