Come installare Wiki.js su Debian 12

Wiki.js è un software wiki gratuito e open-source basato su Node.js, Git e Markdown. È rilasciato sotto la licenza AGPL-v3 ed è progettato per le prestazioni e la conservazione delle risorse di sistema. Wiki.js è un potente software wiki che può essere installato ovunque nel tuo sistema. Puoi installarlo sul tuo sistema operativo o utilizzare servizi cloud come Heroku, e anche distribuire Wiki.js nei tuoi ambienti container, come Docker e Kubernetes.

Wiki.js è compatibile con il database PostgreSQL e fornisce oltre 50 integrazioni per autenticazione aggiuntiva, sistema di logging, motore di ricerca, rendering e archiviazione. È un potente software wiki costruito su interfacce belle e intuitive sia per il pannello di amministrazione che per le pagine. È un software wiki completamente personalizzabile per documentare il tuo stack tecnologico.

In questo articolo, ti mostreremo come installare Wiki.js su un sistema Debian 12. Ti guideremo attraverso l’installazione di Wiki.js, utilizzando un server di database PostgreSQL, Nginx come reverse proxy, e poi a mettere in sicurezza la tua istanza di Wiki.js con certificati SSL/TLS da Let’s Encrypt.

Prerequisiti

Prima di procedere, assicurati di avere:

• Un server Debian 12.
• Un utente non root con privilegi di amministratore.
• Un nome di dominio puntato all’indirizzo IP del tuo server. Questo esempio utilizzerà il dominio wiki.howtoforge.local.

Installazione delle dipendenze

Nella prima fase, installerai alcune delle dipendenze che saranno utilizzate da Wiki.js, che includono:

• Server di database PostgreSQL: Questo sarà utilizzato come database per il tuo Wiki.js.
• Server web Nginx: Il server web Nginx sarà utilizzato come reverse proxy per Wiki.js.
• Node.js e NPM: Il motore di runtime JavaScript Node.js e il gestore pacchetti NPM.
• Certbot e Nginx Certbot Plugin: Certbot per generare certificati SSL/TLS tramite Let’s Encrypt e il plugin Certbot Nginx confermerà automaticamente il tuo blocco del server Nginx con HTTPS.

Per iniziare, aggiorna e aggiorna il repository Debian utilizzando il comando qui sotto prima di installare i pacchetti.

sudo apt update

Ora installa le dipendenze dei pacchetti per Wiki.js tramite il comando apt install qui sotto. Con il seguente comando, installerai il server di database PostgreSQL, Node.js e NPM, il server web Nginx, Certbot e il plugin Certbot Nginx.

sudo apt install postgresql postgresql-common nodejs npm nginx certbot python3-certbot-nginx

Digita y per confermare e procedere con l’installazione.

Una volta installate le dipendenze, verifica ciascuna di esse utilizzando i seguenti comandi.

Verifica lo stato del servizio PostgreSQL utilizzando il comando systemctl qui sotto.

sudo systemctl is-enabled postgresql  
sudo systemctl status postgresql

Un output simile qui sotto verrà mostrato.

Verifica lo stato del servizio Nginx per assicurarti che sia in esecuzione e abilitato.

sudo systemctl is-enabled nginx  
sudo systemctl status nginx

Se Nginx è in esecuzione e abilitato, l’output qui sotto verrà visualizzato nel tuo terminale.

Infine, verifica Node.js e NPM eseguendo il seguente comando. L’output mostrerà le versioni correnti di Node.js e NPM installate sul tuo sistema.

node --version  
npm --version

Creazione di un database e utente PostgreSQL

Dopo aver installato le dipendenze, il passo successivo è creare un nuovo database e un utente per la tua installazione di Wiki.js. Per farlo, devi accedere a PostgreSQL tramite il client psql.

Accedi al server PostgreSQL eseguendo il seguente comando.

sudo -u postgres psql

Una volta effettuato l’accesso, esegui le seguenti query per creare un nuovo database PostgreSQL e un utente wikijs. Assicurati di cambiare la password nelle seguenti query.

CREATE USER wikijs WITH PASSWORD 'p4ssw0rd';  
CREATE DATABASE wikijs OWNER wikijs;

Dopo che il database e l’utente sono stati creati, verifica la loro esistenza utilizzando le seguenti query per elencare i database e gli utenti disponibili sulla tua istanza PostgreSQL.

du  

l

Dovresti vedere il database e l’utente wikijs creati su PostgreSQL.

Digita quit per uscire dal server PostgreSQL.

Download del codice sorgente di Wiki.js

Nella sezione seguente, scaricherai il codice sorgente di Wiki.js sul tuo server e imposterai la directory di installazione con i permessi e la proprietà corretti.

Crea un nuovo utente wikijs eseguendo il seguente comando.

sudo useradd -m -s /bin/false wikijs

Ora crea una nuova directory /opt/wikijs e spostati in essa. Poi, scarica il codice sorgente di Wiki.js tramite il comando wget qui sotto.

mkdir -p /opt/wikijs; cd /opt/wikijs  
wget https://github.com/Requarks/wiki/releases/latest/download/wiki-js.tar.gz

Una volta scaricato, estrai il codice sorgente di Wiki.js e cambia la proprietà della directory /opt/wikijs all’utente wikijs.

tar -xf wiki-js.tar.gz  
sudo chown -R wikijs:wikijs /opt/wikijs

Configurazione di Wiki.js

Con Wiki.js scaricato, configurerai ora la tua installazione di Wiki.js con il database e l’utente PostgreSQL, e configurerai anche l’indirizzo IP di binding per Wiki.js.

Copia la configurazione predefinita di Wiki.js config.sample.yml in config.yml, quindi aprila utilizzando il seguente editor nano.

sudo -u wikijs cp config.sample.yml config.yml  
sudo -u wikijs nano config.yml

Cambia la configurazione del database predefinita con il tuo database PostgreSQL, utente e password.

  # PostgreSQL / MySQL / MariaDB / MS SQL Server solo:  
  host: localhost  
  port: 5432  
  user: wikijs  
  pass: p4ssw0rd  
  db: wikijs  
  ssl: false

Cambia l’opzione bindIP predefinita in localhost o 127.0.0.1. Questo eseguirà Wiki.js su localhost.

bindIP: 127.0.0.1

Salva ed esci dopo aver finito.

Successivamente, esegui il seguente comando per eseguire e testare la tua installazione di Wiki.js.

sudo -u wikijs node server

Dovresti vedere la conferma che Wiki.js è in esecuzione su localhost con la porta predefinita 3000.

Infine, premi Ctrl+c per terminare il processo di Wiki.js.

Esecuzione di Wiki.js in background come servizio

Ora che hai completato la configurazione di Wiki.js, il passo successivo sarà impostare Wiki.js per eseguire in background come servizio systemd. Utilizzando il seguente approccio, puoi gestire facilmente Wiki.js tramite l’utilità systemctl.

Crea un nuovo file di servizio systemd per Wiki.js /etc/systemd/system/wikijs.service utilizzando il comando dell’editor nano qui sotto.

sudo nano /etc/systemd/system/wikijs.service

Inserisci la seguente configurazione che abiliterà Wiki.js a eseguire in background come servizio.

[Unit]  
Description=Wiki.js  
After=network.target postgresql.service  
  
[Service]  
Type=simple  
ExecStart=/usr/bin/node server  
Restart=always  
  
User=wikijs  
Environment=NODE_ENV=production  
WorkingDirectory=/opt/wikijs  
  
[Install]  
WantedBy=multi-user.target

Salva il file ed esci dall’editor quando hai finito.

Successivamente, esegui il comando systemctl qui sotto per ricaricare il gestore systemd e applicare il nuovo file di servizio per Wiki.js.

sudo systemctl daemon-reload

Ora puoi avviare e abilitare il servizio wiki.js utilizzando il comando qui sotto. Questo avvierà Wiki.js in background su localhost con la porta predefinita 3000 e lo abiliterà a eseguire automaticamente all’avvio.

sudo systemctl start wikijs  
sudo systemctl enable wikijs

Verifica il servizio wikijs utilizzando il comando qui sotto per assicurarti che il servizio sia in esecuzione.

sudo systemctl status wikijs

Un output qui sotto dovrebbe essere presentato.

Infine, esegui il comando ss qui sotto per verificare la porta 3000 che è utilizzata dall’applicazione Wiki.js.

ss -tulpn | grep 3000

Se Wiki.js è in esecuzione, dovresti vedere che l’applicazione Node.js utilizza la porta 3000.

Configurazione di Nginx come reverse proxy

Ora che Wiki.js è in esecuzione su localhost con la porta predefinita 3000. Nel passo successivo, creerai una nuova configurazione del blocco del server Nginx che sarà utilizzata come reverse proxy per Wiki.js. Prima di iniziare, assicurati di avere un nome di dominio puntato all’indirizzo IP del tuo server.

Crea una nuova configurazione del blocco del server Nginx /etc/nginx/sites-available/wikijs utilizzando il seguente comando dell’editor nano.

sudo nano /etc/nginx/sites-available/wikijs

Inserisci la seguente configurazione e assicurati di cambiare il nome di dominio della tua installazione di Wiki.js.

server {  
    listen 80;  
    server_name wiki.howtoforge.local;  
  
    root /opt/wikijs;  
  
    access_log  /var/log/nginx/wikijs.access.log;  
    error_log   /var/log/nginx/wikijs.error.log;  
  
    location / {  
        proxy_http_version 1.1;  
        proxy_set_header Upgrade $http_upgrade;  
        proxy_set_header Connection "upgrade";  
        proxy_set_header Host $http_host;  
        proxy_set_header X-Real-IP $remote_addr;  
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;  
        proxy_set_header X-Forwarded-Proto $scheme;  
        proxy_pass http://127.0.0.1:3000;  
    }  
}

Salva il file ed esci dall’editor quando hai finito.

Successivamente, esegui il seguente comando per abilitare la configurazione del blocco del server Wiki.js e verificare la sintassi di Nginx.

sudo ln -s /etc/nginx/sites-available/wikijs /etc/nginx/sites-enabled  
sudo nginx -t

Se hai una sintassi Nginx corretta, dovresti ricevere un output test è riuscito - sintassi è ok.

Ora riavvia il servizio Nginx utilizzando il comando qui sotto per applicare il nuovo blocco del server che hai configurato.

sudo systemctl restart nginx

Una volta che Nginx è stato riavviato, apri il tuo browser web preferito e visita il nome di dominio della tua installazione di Wiki.js, come http://wiki.howtoforge.local/. Se tutto va bene, dovresti vedere la pagina di installazione di Wiki.js come questa:

Messa in sicurezza di Wiki.js con certificati SSL/TLS

Nel passo seguente, metterai in sicurezza la tua installazione di Wiki.js con certificati SSL/TLS da Letsencrypt. Inoltre, configurerai l’HTTP automatico su HTTPS tramite il plugin Certbot Nginx.

Esegui il comando certbot qui sotto per generare nuovi certificati SSL/TLS da letsencrypt. Assicurati di cambiare i dettagli del nome di dominio e dell’indirizzo email con le tue informazioni.

sudo certbot --nginx --agree-tos --redirect --hsts --staple-ocsp --email [email protected] -d wiki.howtoforge.local

Dopo che il processo è terminato, i tuoi certificati SSL saranno disponibili nella directory /etc/letsencrypt/live/wiki.howtoforge.local/. Per quanto riguarda la configurazione del blocco del server Wiki.js, sarà automaticamente configurata con HTTPS tramite il plugin Certbot Nginx.

Avvio dell’installazione di Wiki.js

Torna al tuo browser web e visita il nome di dominio di Wiki.js, ad esempio, http://wiki.howtoforge.local/. Dovresti essere automaticamente reindirizzato a una connessione HTTPS sicura.

Ora crea l’utente amministratore per Wiki.js e inserisci il tuo indirizzo email e password. Quindi, fai clic su INSTALLA per confermare l’installazione.

Una volta completata l’installazione, dovresti essere reindirizzato alla pagina di accesso di Wiki.js. Inserisci il tuo indirizzo email amministrativo e la password, quindi fai clic su ACCEDI.

Se la tua installazione ha avuto successo, dovresti vedere la pagina di benvenuto di Wiki.js. Da qui, puoi creare una nuova homepage o accedere al pannello di amministrazione di Wiki.js.

Se fai clic su AMMINISTRAZIONE, dovresti vedere la pagina di amministrazione di Wiki.js come questa:

Nella sezione SYSTEM, fai clic sul menu Informazioni di sistema per ottenere informazioni dettagliate sulla tua installazione di Wiki.js. Qui sotto dovresti vedere che Wiki.js 2.5 è installato con Node.js 18.x e PostgreSQL 15.x.

Conclusione

Questo è tutto! Hai seguito tutti i passaggi e installato Wiki.js sul tuo sistema Debian 12, completo di un server di database PostgreSQL, Nginx come reverse proxy e messo in sicurezza l’installazione tramite certificati SSL/TLS da Let’s Encrypt. Puoi ora iniziare a costruire la documentazione della tua azienda con Wiki.js.