Wiki.js è un'app wiki moderna, gratuita e open source, costruita su Node.js, MongoDB, Git e Markdown. Il codice sorgente di Wiki.js è ospitato pubblicamente su Github . Questa guida ti mostrerà come installare Wiki.js su una nuova istanza di FreeBSD 11 Vultr usando Node.js, MongoDB, PM2, Nginx, Git e Acme.sh.
Requisiti
I requisiti per eseguire Wiki.js sono i seguenti:
- Node.js versione 6.11.1 o successive
- MongoDB versione 3.2 o successive
- Git versione 2.7.4 o successive
- Un server Web come Nginx, Apache, IIS, Caddy o H2O. Questa guida utilizzerà Nginx.
- Un repository conforme a Git (pubblico o privato) Questo è facoltativo
- Almeno 512 MB di RAM. Si consiglia vivamente di utilizzare una macchina con almeno 1 GB di RAM.
- Nome dominio con
A
/ AAAA
record impostati. In questa guida useremo wiki.example.com
come dominio di esempio.
Prima di iniziare
Controlla la versione di FreeBSD.
uname -ro
# FreeBSD 11.2-RELEASE
Assicurati che il tuo sistema FreeBSD sia aggiornato.
freebsd-update fetch install
pkg update && pkg upgrade -y
Installare sudo
, vim
, unzip
, wget
, git
, bash
e socat
pacchetti se non sono presenti nel sistema.
pkg install -y sudo vim unzip wget git bash socat
Crea un nuovo account utente con il tuo nome utente preferito (useremo johndoe
).
adduser
# Username: johndoe
# Full name: John Doe
# Uid (Leave empty for default): <Enter>
# Login group [johndoe]: <Enter>
# Login group is johndoe. Invite johndoe into other groups? []: wheel
# Login class [default]: <Enter>
# Shell (sh csh tcsh nologin) [sh]: bash
# Home directory [/home/johndoe]: <Enter>
# Home directory permissions (Leave empty for default): <Enter>
# Use password-based authentication? [yes]: <Enter>
# Use an empty password? (yes/no) [no]: <Enter>
# Use a random password? (yes/no) [no]: <Enter>
# Enter password: your_secure_password
# Enter password again: your_secure_password
# Lock out the account after creation? [no]: <Enter>
# OK? (yes/no): yes
# Add another user? (yes/no): no
# Goodbye!
Esegui il visudo
comando e decommenta la %wheel ALL=(ALL) ALL
riga per consentire ai membri del wheel
gruppo di eseguire qualsiasi comando.
# Uncomment by removing the hash (#) sign
%wheel ALL=(ALL) ALL
Ora passa al nuovo utente creato.
su - johndoe
NOTA: sostituisci johndoe
con il tuo nome utente.
Imposta il fuso orario.
sudo tzsetup
Installa Node.js
Wiki.js richiede Node.js 6.11.1 o successivo, quindi dovremo prima installare la versione appropriata di Node.js.
Installa Node.js e NPM.
sudo pkg install -y node8 npm-node8
Controlla le versioni.
node -v && npm -v
# v8.12.0
# 6.4.1
Installa MongoDB
Wiki.js utilizza MongoDB come motore di database.
Installa MongoDB.
sudo pkg install -y mongodb36
Controlla la versione
mongo --version | head -n 1 && mongod --version | head -n 1
# MongoDB shell version v3.6.6
# db version v3.6.6
Abilita e avvia MongoDB.
sudo sysrc mongod_enable=yes
sudo service mongod start
Installa Acme.sh e ottieni un certificato Let's Encrypt ( opzionale )
Non è necessario proteggere la tua wiki con HTTPS, ma è buona norma proteggere il traffico del tuo sito. Per ottenere un certificato SSL da Let's Encrypt utilizzeremo il client Acme.sh. Acme.sh è un software di shell unix puro per ottenere certificati SSL da Let's Encrypt con zero dipendenze. Ciò lo rende molto leggero rispetto ad altri client con protocollo Acme che richiedono molte dipendenze per funzionare correttamente.
Scarica e installa Acme.sh.
sudo mkdir /etc/letsencrypt
git clone https://github.com/Neilpang/acme.sh.git
cd acme.sh
sudo ./acme.sh --install --home /etc/letsencrypt --accountemail [email protected]
cd ~
Controlla la acme.sh
versione
/etc/letsencrypt/acme.sh --version
# v2.8.0
Ottieni i certificati RSA ed ECDSA per wiki.example.com
.
# RSA 2048
sudo /etc/letsencrypt/acme.sh --issue --standalone --home /etc/letsencrypt -d wiki.example.com --ocsp-must-staple --keylength 2048
# ECDSA/ECC P-256
sudo /etc/letsencrypt/acme.sh --issue --standalone --home /etc/letsencrypt -d wiki.example.com --ocsp-must-staple --keylength ec-256
Dopo aver eseguito i comandi sopra, i certificati e le chiavi saranno nelle seguenti directory:
- RSA:
/etc/letsencrypt/wiki.example.com
- ECC / ECDSA:
/etc/letsencrypt/wiki.example.com_ecc
NOTA: non dimenticare di sostituire wiki.example.com
con il tuo nome di dominio.
Dopo aver ottenuto i certificati da Let's Encrypt, dobbiamo configurare Nginx per sfruttarli.
Wiki.js può essere eseguito senza un vero server Web, tuttavia si consiglia vivamente di metterlo di fronte un server Web standard. In questo modo è possibile utilizzare funzionalità come SSL, più siti Web, memorizzazione nella cache e altri. Useremo Nginx in questo tutorial, ma qualsiasi altro server lo farà, devi solo configurarlo correttamente.
Installa Nginx.
sudo pkg install -y nginx
Controlla la versione
nginx -v
# nginx version: nginx/1.14.0
Abilita e avvia Nginx.
sudo sysrc nginx_enable=yes
sudo service nginx start
Configurare Nginx come proxy inverso HTTPS (se si utilizza SSL) per l'applicazione Wiki.js.
Eseguilo sudo vim /usr/local/etc/nginx/wiki.js.conf
e popolalo con la configurazione di base del proxy inverso di seguito.
server {
listen [::]:443 ssl http2;
listen 443 ssl http2;
listen [::]:80;
listen 80;
server_name wiki.example.com;
charset utf-8;
client_max_body_size 50M;
# RSA
ssl_certificate /etc/letsencrypt/wiki.example.com/fullchain.cer;
ssl_certificate_key /etc/letsencrypt/wiki.example.com/wiki.example.com.key;
# ECDSA
ssl_certificate /etc/letsencrypt/wiki.example.com_ecc/fullchain.cer;
ssl_certificate_key /etc/letsencrypt/wiki.example.com_ecc/wiki.example.com.key;
location / {
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_pass http://127.0.0.1:3000;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_next_upstream error timeout http_502 http_503 http_504;
}
}
L'unica cosa che devi cambiare nella configurazione sopra è la server_name
direttiva, e potenzialmente la proxy_pass
direttiva se decidi di configurare una porta diversa da quella 3000
. Wiki.js utilizza la porta 3000
per impostazione predefinita. Salvare il file e uscire con :+ W+Q
Ora dobbiamo includere il wiki.js.conf
file nel nginx.conf
file principale .
Esegui sudo vim /usr/local/etc/nginx/nginx.conf
e aggiungi la seguente riga al http {}
blocco.
include wiki.js.conf;
Controlla la configurazione.
sudo nginx -t
Ricarica Nginx.
sudo service nginx reload
Installa Wiki.js
Crea una cartella radice del documento vuota in cui verrà installato Wiki.js.
sudo mkdir -p /usr/local/www/wiki.example.com
Passare alla cartella principale del documento.
cd /usr/local/www/wiki.example.com
Cambia la proprietà della /usr/local/www/wiki.example.com
cartella in utente johndoe
.
sudo chown -R johndoe:johndoe /usr/local/www/wiki.example.com
Dalla /usr/local/www/wiki.example.com
cartella, eseguire i seguenti comandi per scaricare e installare Wiki.js.
curl -sSo- https://wiki.js.org/install.sh | bash
VERSION=$(curl -L -s -S https://beta.requarks.io/api/version/stable)
curl -L -s -S https://github.com/Requarks/wiki/releases/download/v$VERSION/wiki-js.tar.gz | tar -f - -xz -C .
curl -L -s -S https://github.com/Requarks/wiki/releases/download/v$VERSION/node_modules.tar.gz | tar -f - -xz -C .
cp -n config.sample.yml config.yml
È possibile eseguire il comando seguente per visualizzare la versione attualmente installata di Wiki.js.
node wiki --version
# 1.0.102
Una volta completata l'installazione, ti verrà richiesto di eseguire la procedura guidata di configurazione.
Avviare la procedura guidata di configurazione eseguendo.
node wiki configure
Questo ti avviserà di navigare http://localhost:3000
per configurare Wiki.js. Se hai Nginx davanti a Wiki.js, significa che puoi aprire il tuo nome di dominio (ad esempio http://wiki.example.com
) invece di andare su localhost.
Utilizzando il browser Web, navigare http://wiki.example.com
e seguire le istruzioni visualizzate. Tutte le impostazioni immesse durante la procedura guidata di configurazione vengono salvate nel config.yml
file. La procedura guidata di configurazione avvierà automaticamente Wiki.js per te.
Installa e imposta il gestore processi PM2
Per impostazione predefinita, Wiki.js non si avvia automaticamente dopo il riavvio del sistema. Per avviarlo all'avvio, è necessario installare e configurare il gestore processi PM2.
Installa PM2 a livello globale tramite npm
.
sudo npm install -g pm2
Controlla la versione
pm2 -v
# 3.2.2
Passa alla cartella principale del documento se non ci sei già e ferma Wiki.js.
cd /usr/local/www/wiki.example.com
node wiki stop
Avviare Wiki.js tramite PM2.
pm2 start server/index.js --name "Wiki.js"
Elenco processo gestito da PM2.
pm2 list
Di 'a PM2 di configurarsi come servizio di avvio eseguendo:
pm2 startup
Infine, salva la configurazione PM2 corrente eseguendo il comando:
pm2 save
L'istanza di Wiki.js ora viene eseguita come processo in background, utilizzando PM2 come gestore dei processi.