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 FreeBSD 11 Vultr en utilisant Node.js, MongoDB, PM2, Nginx, Git et Acme.sh.
Exigences
Les exigences pour exécuter Wiki.js sont les suivantes:
- Node.js version 6.11.1 ou ultérieure
- MongoDB version 3.2 ou ultérieure
- Git version 2.7.4 ou ultérieure
- Un serveur Web tel que Nginx, Apache, IIS, Caddy ou H2O. Ce guide utilisera Nginx.
- Un référentiel compatible Git (public ou privé) Ceci est facultatif
- Un minimum de 512 Mo de RAM. Il est fortement recommandé d'utiliser une machine avec au moins 1 Go de RAM.
- Nom de domaine avec
A
/ AAAA
enregistrements configurés. Dans ce guide, nous utiliserons wiki.example.com
comme exemple de domaine.
Avant que tu commences
Vérifiez la version de FreeBSD.
uname -ro
# FreeBSD 11.2-RELEASE
Assurez-vous que votre système FreeBSD est à jour.
freebsd-update fetch install
pkg update && pkg upgrade -y
Installer sudo
, vim
, unzip
, wget
, git
, bash
et les socat
paquets si elles ne sont pas présents sur votre système.
pkg install -y sudo vim unzip wget git bash socat
Créez un nouveau compte utilisateur avec votre nom d'utilisateur préféré (nous utiliserons 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!
Exécutez la visudo
commande et décommentez la %wheel ALL=(ALL) ALL
ligne pour permettre aux membres du wheel
groupe d'exécuter n'importe quelle commande.
# Uncomment by removing the hash (#) sign
%wheel ALL=(ALL) ALL
Maintenant, passez à votre nouvel utilisateur.
su - johndoe
REMARQUE: remplacez johndoe
par votre nom d'utilisateur.
Configurez le fuseau horaire.
sudo tzsetup
Installez Node.js
Wiki.js nécessite Node.js 6.11.1 ou une version ultérieure, nous devons donc d'abord installer la version appropriée de Node.js.
Installez Node.js et NPM.
sudo pkg install -y node8 npm-node8
Vérifiez les versions.
node -v && npm -v
# v8.12.0
# 6.4.1
Installer MongoDB
Wiki.js utilise MongoDB comme moteur de base de données.
Installez MongoDB.
sudo pkg install -y mongodb36
Vérifiez la version.
mongo --version | head -n 1 && mongod --version | head -n 1
# MongoDB shell version v3.6.6
# db version v3.6.6
Activez et démarrez MongoDB.
sudo sysrc mongod_enable=yes
sudo service mongod start
Installez Acme.sh et obtenez un certificat Let's Encrypt ( facultatif )
Sécuriser votre wiki avec HTTPS n'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 du 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 acme.sh
version.
/etc/letsencrypt/acme.sh --version
# v2.8.0
Obtenez les certificats RSA et ECDSA pour 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
Après avoir exécuté les commandes ci-dessus, vos certificats et clés seront dans les répertoires suivants:
- RSA:
/etc/letsencrypt/wiki.example.com
- ECC / ECDSA:
/etc/letsencrypt/wiki.example.com_ecc
REMARQUE: n'oubliez pas de remplacer wiki.example.com
par votre nom de domaine.
Après avoir obtenu les certificats de Let's Encrypt, nous devons configurer Nginx pour en tirer parti.
Wiki.js peut fonctionner sans aucun serveur Web réel, mais il est fortement recommandé de placer un serveur Web standard devant lui. Cela garantit que vous pouvez utiliser des fonctionnalités telles que SSL, plusieurs sites Web, la mise en cache et autres. Nous utiliserons Nginx dans ce tutoriel, mais tout autre serveur fera l'affaire, il vous suffit de le configurer correctement.
Installez Nginx.
sudo pkg install -y nginx
Vérifiez la version.
nginx -v
# nginx version: nginx/1.14.0
Activez et démarrez Nginx.
sudo sysrc nginx_enable=yes
sudo service nginx start
Configurez Nginx comme proxy inverse HTTPS (si vous utilisez SSL) pour l'application Wiki.js.
Exécutez-le sudo vim /usr/local/etc/nginx/wiki.js.conf
et remplissez-le avec la configuration de base du proxy inverse ci-dessous.
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;
}
}
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 que 3000
. Wiki.js utilise le port 3000
par défaut. Enregistrez le fichier et quittez avec :+ W+Q
Maintenant, nous devons inclure le wiki.js.conf
fichier dans le nginx.conf
fichier principal .
Exécutez sudo vim /usr/local/etc/nginx/nginx.conf
et ajoutez la ligne suivante au http {}
bloc.
include wiki.js.conf;
Vérifiez la configuration.
sudo nginx -t
Recharger Nginx.
sudo service nginx reload
Installez Wiki.js
Créez un dossier racine de document vide dans lequel Wiki.js sera installé.
sudo mkdir -p /usr/local/www/wiki.example.com
Accédez au dossier racine du document.
cd /usr/local/www/wiki.example.com
Changez la propriété du /usr/local/www/wiki.example.com
dossier en utilisateur johndoe
.
sudo chown -R johndoe:johndoe /usr/local/www/wiki.example.com
À partir du /usr/local/www/wiki.example.com
dossier, exécutez les commandes suivantes pour télécharger et installer 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
Vous pouvez exécuter la commande suivante afin d'afficher la version actuellement installée de Wiki.js.
node wiki --version
# 1.0.102
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:3000
pour 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'aller sur 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 et configurer le gestionnaire de processus 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 installer et configurer le gestionnaire de processus PM2.
Installez PM2 globalement via npm
.
sudo npm install -g pm2
Vérifiez la version.
pm2 -v
# 3.2.2
Accédez à votre dossier racine de document si vous n'y êtes pas déjà et arrêtez Wiki.js.
cd /usr/local/www/wiki.example.com
node wiki stop
Démarrez Wiki.js via PM2.
pm2 start server/index.js --name "Wiki.js"
Processus de liste géré par PM2.
pm2 list
Dites à PM2 de se configurer en tant que service de démarrage en exécutant:
pm2 startup
Enfin, enregistrez la configuration PM2 actuelle en exécutant la commande:
pm2 save
Votre instance Wiki.js s'exécute désormais en tant que processus d'arrière-plan, utilisant PM2 comme gestionnaire de processus.