Wiki.js est une application wiki moderne et gratuite, basée sur Node.js , Git et Markdown . Le code source de Wiki.js est publiquement hébergé sur Github . Ce guide vous montrera comment installer Wiki.js sur une nouvelle instance Vultr Ubuntu 18.04 LTS Vultr en utilisant Node.js, MongoDB, PM2, Nginx, Git et Acme.sh.
Exigences
Les exigences pour exécuter Wiki.js et terminer ce guide sont les suivantes:
- Node.js version 6.9.0 ou ultérieure
- MongoDB version 3.2 ou ultérieure
- Nginx
- Git version 2.7.4 ou ultérieure
- 768 Mo de RAM minimum
- Nom de domaine avec
A
/ AAAA
enregistrements configurés
Vérifiez la version d'Ubuntu.
lsb_release -ds
# Ubuntu 18.04.4 LTS
Créez un nouveau non-root
compte utilisateur avec sudo
accès et passez-y.
adduser johndoe --gecos "John Doe"
usermod -aG sudo johndoe
su - johndoe
REMARQUE : remplacez johndoe
par votre nom d'utilisateur.
Configurez le fuseau horaire.
sudo dpkg-reconfigure tzdata
Assurez-vous que votre système est à jour.
sudo apt update && sudo apt upgrade -y
Installez les packages nécessaires.
sudo apt install -y build-essential apt-transport-https
Installer Git
Git 2.7.4 est préinstallé sur l'édition du serveur Ubuntu, nous n'avons donc pas besoin de l'installer. Si vous souhaitez installer une version plus récente, vous pouvez utiliser des PPA tiers ou compiler la dernière version de Git à partir des sources.
Vous pouvez vérifier la version actuellement installée de Git en exécutant:
git --version
# git version 2.7.4
Si vous souhaitez installer une version plus récente du logiciel Git, vous pouvez utiliser ce qui suit.
# Remove existing git package
sudo apt remove -y git
sudo apt-get install software-properties-common
sudo add-apt-repository -y ppa:git-core/ppa
sudo apt update && sudo apt upgrade -y
sudo apt install -y git
Vérifiez la version de Git.
git --version
# git version 2.17.0
Installez Node.js
Installez Node.js en utilisant le référentiel NodeSource APT pour Node.js.
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt install -y nodejs
Vérifiez les versions Node.js et NPM.
node -v && npm -v
# v8.11.2
# 5.6.0
Installer MongoDB
Nous utiliserons les référentiels officiels MongoDB , qui sont tenus à jour avec les dernières versions majeures et mineures de MongoDB.
Installez MongoDB Community Edition.
sudo apt install -y mongodb
Vérifiez la version.
mongo --version | head -n 1 && mongod --version | head -n 1
# MongoDB shell version v3.6.3
# db version v3.6.3
Installez Nginx.
wget https://nginx.org/keys/nginx_signing.key
sudo apt-key add nginx_signing.key
rm nginx_signing.key
sudo -s
printf "deb https://nginx.org/packages/mainline/ubuntu/ $(lsb_release -sc) nginx\ndeb-src https://nginx.org/packages/mainline/ubuntu/ $(lsb_release -sc) nginx\n" >> /etc/apt/sources.list.d/nginx_mainline.list
exit
sudo apt update
sudo apt install -y nginx
Vérifiez la version.
sudo nginx -v
# nginx version: nginx/1.15.0
Activez et démarrez Nginx.
sudo systemctl enable nginx.service
sudo systemctl start nginx.service
Configurez Nginx comme proxy inverse pour l'application Wiki.js.
Exécutez-le sudo vim /etc/nginx/conf.d/wiki.js.conf
et remplissez-le avec la configuration de base du proxy inverse ci-dessous.
server {
listen [::]:80;
listen 80;
server_name wiki.example.com;
root /usr/share/nginx/html;
charset utf-8;
client_max_body_size 50M;
location /.well-known/acme-challenge/ {
allow all;
}
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;
}
}
La seule chose que vous devez changer dans la configuration ci-dessus est la server_name
directive et potentiellement la proxy_pass
directive si vous décidez de configurer un autre port en plus 3000
. Wiki.js utilise le port 3000
par défaut.
Vérifiez la configuration.
sudo nginx -t
Recharger Nginx.
sudo systemctl reload nginx.service
Installez le client Acme.sh et obtenez un certificat Let's Encrypt (facultatif)
Sécuriser votre wiki avec HTTPS
n'est pas nécessaire, mais cela sécurisera le trafic de votre site. Acme.sh est un logiciel shell Unix pur pour obtenir des certificats SSL à partir de Let's Encrypt sans aucune dépendance.
Téléchargez et installez 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 ~
Vérifiez la version.
/etc/letsencrypt/acme.sh --version
Obtenez les certificats RSA et ECDSA pour le wiki.example.com
domaine / nom d'hôte.
# RSA 2048
sudo /etc/letsencrypt/acme.sh --issue --home /etc/letsencrypt -d wiki.example.com --webroot /usr/share/nginx/html --reloadcmd "sudo systemctl reload nginx.service" --accountemail [email protected] --ocsp-must-staple --keylength 2048
# ECDSA/ECC P-256
sudo /etc/letsencrypt/acme.sh --issue --home /etc/letsencrypt -d wiki.example.com --webroot /usr/share/nginx/html --reloadcmd "sudo systemctl reload nginx.service" --accountemail [email protected] --ocsp-must-staple --keylength ec-256
Après avoir exécuté les commandes ci-dessus, vos certificats et clés seront dans:
- Pour RSA: le
/etc/letsencrypt/wiki.example.com
répertoire.
- Pour ECC / ECDSA: le
/etc/letsencrypt/wiki.example.com_ecc
répertoire.
Après avoir obtenu les certificats de Let's Encrypt, nous devons configurer Nginx pour les utiliser.
Réexécutez sudo vim /etc/nginx/conf.d/wiki.js.conf
et configurez Nginx en tant que HTTPS
proxy inverse.
server {
listen [::]:443 ssl http2;
listen 443 ssl http2;
listen [::]:80;
listen 80;
server_name wiki.example.com;
root /usr/share/nginx/html;
charset utf-8;
client_max_body_size 50M;
location /.well-known/acme-challenge/ {
allow all;
}
# 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;
}
}
Vérifiez la configuration.
sudo nginx -t
Recharger Nginx.
sudo systemctl reload nginx.service
Installez Wiki.js
Créez un dossier racine de document vide dans lequel Wiki.js doit être installé.
sudo mkdir -p /var/www/wiki.example.com
Accédez au dossier racine du document.
cd /var/www/wiki.example.com
Changez la propriété du /var/www/wiki.example.com
dossier pour l'utilisateur johndoe
.
sudo chown -R johndoe:johndoe /var/www/wiki.example.com
À partir du /var/www/wiki.example.com
dossier, exécutez la commande suivante pour télécharger et installer Wiki.js.
curl -sSo- https://wiki.js.org/install.sh | bash
Pour afficher la version actuellement installée de Wiki.js, vous pouvez exécuter la commande suivante.
node wiki --version
# 1.0.78
Une fois l'installation terminée, vous serez invité à exécuter l'assistant de configuration.
Démarrez l'assistant de configuration.
node wiki configure
Cela vous indiquera de parcourir http://localhost:3000
pour configurer Wiki.js. Si vous avez Nginx devant Wiki.js, vous pouvez ouvrir votre nom de domaine (par exemple http://wiki.example.com
) au lieu d'y aller localhost
.
À l'aide de votre navigateur Web, accédez aux http://wiki.example.com
instructions à l'écran et suivez-les. Tous les paramètres entrés lors de l'assistant de configuration sont enregistrés dans le config.yml
fichier. L'assistant de configuration démarrera automatiquement Wiki.js pour vous.
Installer PM2
Par défaut, Wiki.js ne démarre pas automatiquement après un redémarrage du système. Afin de le faire démarrer au démarrage, nous devons configurer PM2. PM2 est fourni avec Wiki.js en tant que module NPM local, nous n'avons donc pas besoin d'installer PM2 globalement.
Dites à PM2 de se configurer en tant que service de démarrage.
/var/www/wiki.example.com/node_modules/pm2/bin/pm2 startup
Enfin, enregistrez la configuration PM2 actuelle.
/var/www/wiki.example.com/node_modules/pm2/bin/pm2 save
Wiki.js fonctionne comme un processus d'arrière-plan, utilisant PM2 comme gestionnaire de processus.