Wiki.js est une application wiki moderne gratuite et open source basée sur Node.js, MongoDB, 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 de Debian 9 Vultr en utilisant Node.js, MongoDB, PM2, Nginx, Git et Acme.sh.
Exigences
- Node.js 6.9.0 ou version ultérieure
- MongoDB 3.2 ou version ultérieure
- Nginx
- Git 2.7.4 ou version ultérieure
- Un référentiel compatible Git (public ou privé) ( facultatif )
- Minimum de
768MB RAM
- Nom de domaine avec
A/ AAAAenregistrements configurés
Vérifiez la version Debian.
lsb_release -ds
# Debian GNU/Linux 9.4 (stretch)
Assurez-vous que votre système est à jour.
apt update && apt upgrade -y
Installez les packages nécessaires.
apt install -y build-essential apt-transport-https sudo curl wget dirmngr sudo
Créez un nouveau non-rootcompte utilisateur avec sudoaccès et passez-y.
adduser johndoe --gecos "John Doe"
usermod -aG sudo johndoe
su - johndoe
REMARQUE : remplacez johndoepar votre nom d'utilisateur.
Configurez le fuseau horaire.
sudo dpkg-reconfigure tzdata
Installer Git
Installez Git sur Debian.
sudo apt install -y git
Vérifiez la version de Git.
git --version
# git version 2.11.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
Wiki.js utilise MongoDB comme moteur de base de données. Selon cela, nous devrons installer MongoDB sur notre serveur. Nous utiliserons les dépôts officiels de MongoDB pour l'installation.
Installez MongoDB Community Edition.
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 2930ADAE8CAF5059EE73BB4B58712A2291FA4AD5
echo "deb http://repo.mongodb.org/apt/debian stretch/mongodb-org/3.6 main" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.6.list
sudo apt update
sudo apt install -y mongodb-org
Vérifiez la version.
mongo --version | head -n 1 && mongod --version | head -n 1
# MongoDB shell version v3.6.5
# db version v3.6.5
Activez et démarrez MongoDB.
sudo systemctl enable mongod.service
sudo systemctl start mongod.service
Il est fortement recommandé de mettre un serveur Web standard devant Wiki.js. Cela garantit que vous pouvez utiliser des fonctionnalités telles que SSL, plusieurs sites Web, la mise en cache et plus encore. Nous utiliserons Nginx dans ce tutoriel, mais tout autre serveur fera l'affaire, il vous suffit de le configurer correctement.
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/debian/ $(lsb_release -sc) nginx\ndeb-src https://nginx.org/packages/mainline/debian/ $(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 en tant que proxy inverse ( HTTPou HTTPSsi vous utilisez SSL) pour l'application Wiki.js.
Exécutez-le sudo vim /etc/nginx/conf.d/wiki.js.confet 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_namedirective, et potentiellement la proxy_passdirective si vous décidez de configurer un autre port que 3000. Wiki.js utilise le port 3000par défaut.
Vérifiez la configuration.
sudo nginx -t
Recharger Nginx.
sudo systemctl reload nginx.service
Installez Acme.sh et obtenez un certificat Let's Encrypt (facultatif)
Sécuriser votre wiki avec HTTPSn'est pas nécessaire, mais c'est une bonne pratique pour sécuriser le trafic de votre site. Afin d'obtenir un certificat SSL de Let's Encrypt, nous utiliserons le client Acme.sh. Acme.sh est un logiciel shell Unix pur pour obtenir des certificats SSL à partir de Let's Encrypt sans aucune dépendance. Cela le rend très léger par rapport à certains autres clients de protocole ACME qui nécessitent beaucoup de dépendances pour fonctionner correctement.
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
# v2.7.9
Obtenez les certificats RSA et ECDSA pour wiki.example.com.
# 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
REMARQUE : n'oubliez pas de remplacer wiki.example.compar votre nom de domaine.
Après avoir exécuté les commandes ci-dessus, vos certificats et clés seront dans les répertoires suivants.
- Pour RSA:
/etc/letsencrypt/wiki.example.comrépertoire.
- Pour ECC / ECDSA:
/etc/letsencrypt/wiki.example.com_eccrépertoire.
Après avoir obtenu les certificats de Let's Encrypt, nous devons configurer Nginx pour en tirer parti.
Réexécutez sudo vim /etc/nginx/conf.d/wiki.js.confet configurez Nginx en tant que HTTPSproxy 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/example.com.key;
# ECDSA
ssl_certificate /etc/letsencrypt/wiki.example.com_ecc/fullchain.cer;
ssl_certificate_key /etc/letsencrypt/wiki.example.com_ecc/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.comdossier en utilisateur johndoe.
sudo chown -R johndoe:johndoe /var/www/wiki.example.com
À partir du /var/www/wiki.example.comdossier, exécutez la commande suivante pour télécharger et installer Wiki.js.
curl -sSo- https://wiki.js.org/install.sh | bash
Vous pouvez exécuter la commande suivante afin d'afficher la version actuellement installée de Wiki.js.
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 en exécutant.
node wiki configure
Cela vous avertira de naviguer http://localhost:3000pour configurer Wiki.js. Si vous avez Nginx devant Wiki.js, cela signifie que 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.cominstructions à l'écran et suivez-les. Tous les paramètres entrés lors de l'assistant de configuration sont enregistrés dans le config.ymlfichier. L'assistant de configuration démarrera automatiquement Wiki.js pour vous.
Configuration 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 le gestionnaire de processus 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
Votre instance Wiki.js s'exécute en tant que processus d'arrière-plan, en utilisant PM2 comme gestionnaire de processus. Vous pouvez redémarrer votre système d'exploitation avec sudo rebootet vérifier si Wiki.js démarre après un redémarrage.